#The ChatDisplayMessage is a user-visible chat message for rendering in the UI object

ChatDisplayMessage is a user-visible chat message for rendering in the UI

string

sender

string

"user" or "assistant"

text

string

timestamp

string (date-time)

GET/v1/analytics/dashboardsRequires auth

#List analytics dashboards

#Parameters

query parameters

linkId

stringquery

Restricts the result to the dashboard scoped to this link. Takes precedence over scope when both are set.

scope

stringquery

Restricts the result by scope. Unset returns every dashboard.

Allowed values

DASHBOARD_SCOPE_UNSPECIFIED

Every dashboard in the workspace, link-scoped or not.

DASHBOARD_SCOPE_WORKSPACE

Only the workspace-wide dashboard, the one with no link.

DASHBOARD_SCOPE_LINK

Only dashboards tied to a link.

#Response

200

Everything worked as expected.

dashboards

array<object>

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/analytics/dashboards?linkId={linkId}&scope={scope}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "dashboards": [
    {
      "chatMessages": [
        {}
      ],
      "config": {
        "widgets": []
      },
      "createdAt": "2026-08-06T23:37:19.471Z",
      "id": "string",
      "linkId": "string",
      "name": "string",
      "updatedAt": "2026-08-06T23:37:19.471Z"
    }
  ]
}

Base URL: https://api.linkbreakers.com

GET/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summaryRequires auth

Returns the last generated analysis, and whether the underlying values have changed since.

path parameters

dashboardId

stringRequiredpath

widgetId

stringRequiredpath

200

Everything worked as expected.

result

object

AnalyticsWidgetResult is a generated result for an on-demand widget tab.

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summary" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "result": {
    "currentCount": 0,
    "generatedAt": "2026-08-06T23:37:19.472Z",
    "sourceCount": 0,
    "stale": false,
    "text": "string",
    "widgetId": "string"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/analytics/dashboardsRequires auth

#Create analytics dashboard

#Parameters

This endpoint does not accept any parameters.

#Request body

config

object

DashboardConfig is the structured configuration for a dashboard

string

Client-supplied dashboard id. Generated server-side when empty.

linkId

string

Link to scope this dashboard to. Empty creates the workspace-wide dashboard.

name

string

Display name. Defaults to "Default Dashboard" when empty.

useDefaultWidgets

boolean

Fill a workspace dashboard with the standard starter widgets instead of leaving it empty. For the first dashboard in a workspace, which is created by one click rather than by a conversation. Ignored when config is set or when link_id is set, and hidden from the agent, which agrees its widgets with the user and would otherwise stack them on top of these.

#Response

200

Everything worked as expected.

dashboard

object

AnalyticsDashboard represents a workspace's analytics dashboard

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/analytics/dashboards" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"config":{"widgets":[{"dataSource":{},"id":"string","position":{},"size":{},"title":"string","visualization":{}}]},"id":"string","linkId":"string","name":"string","useDefaultWidgets":false}'

Sample payload (application/json)

{
  "config": {
    "widgets": [
      {
        "dataSource": {},
        "id": "string",
        "position": {},
        "size": {},
        "title": "string",
        "visualization": {}
      }
    ]
  },
  "id": "string",
  "linkId": "string",
  "name": "string",
  "useDefaultWidgets": false
}

Typical response

{
  "dashboard": {
    "chatMessages": [
      {
        "id": "string",
        "sender": "string",
        "text": "string",
        "timestamp": "2026-08-06T23:37:19.472Z"
      }
    ],
    "config": {
      "widgets": [
        {}
      ]
    },
    "createdAt": "2026-08-06T23:37:19.472Z",
    "id": "string",
    "linkId": "string",
    "name": "string",
    "updatedAt": "2026-08-06T23:37:19.472Z"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summaryRequires auth

Analyses the widget's current values and stores the result. Consumes platform credits, so it runs only when requested.

path parameters

dashboardId

stringRequiredpath

Dashboard holding the widget

widgetId

stringRequiredpath

Widget whose values should be analysed

force

boolean

Regenerate even when the stored result is still current

200

Everything worked as expected.

result

object

AnalyticsWidgetResult is a generated result for an on-demand widget tab.

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summary" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"force":false}'

Sample payload (application/json)

{
  "force": false
}

Typical response

{
  "result": {
    "currentCount": 0,
    "generatedAt": "2026-08-06T23:37:19.472Z",
    "sourceCount": 0,
    "stale": false,
    "text": "string",
    "widgetId": "string"
  }
}

Base URL: https://api.linkbreakers.com

PUT/v1/analytics/dashboards/{id}Requires auth

#Update analytics dashboard

#Parameters

path parameters

stringRequiredpath

ID of the dashboard to update.

#Request body

config

object

DashboardConfig is the structured configuration for a dashboard

name

string

#Response

200

Everything worked as expected.

dashboard

object

AnalyticsDashboard represents a workspace's analytics dashboard

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PUT "https://api.linkbreakers.com/v1/analytics/dashboards/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"config":{"widgets":[{"dataSource":{},"id":"string","position":{},"size":{},"title":"string","visualization":{}}]},"name":"string"}'

Sample payload (application/json)

{
  "config": {
    "widgets": [
      {
        "dataSource": {},
        "id": "string",
        "position": {},
        "size": {},
        "title": "string",
        "visualization": {}
      }
    ]
  },
  "name": "string"
}

Typical response

{
  "dashboard": {
    "chatMessages": [
      {
        "id": "string",
        "sender": "string",
        "text": "string",
        "timestamp": "2026-08-06T23:37:19.474Z"
      }
    ],
    "config": {
      "widgets": [
        {}
      ]
    },
    "createdAt": "2026-08-06T23:37:19.474Z",
    "id": "string",
    "linkId": "string",
    "name": "string",
    "updatedAt": "2026-08-06T23:37:19.474Z"
  }
}

Base URL: https://api.linkbreakers.com

DELETE/v1/analytics/dashboards/{id}Requires auth

#Delete analytics dashboard

Delete a dashboard and its associated agent conversation.

#Parameters

path parameters

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Analytics Dashboard

#The ChatDisplayMessage is a user-visible chat message for rendering in the UI object

#List analytics dashboards

#Parameters

query parameters

Allowed values

#Response

#Error response

#Get a stored widget agent summary

#Parameters

path parameters

#Response

#Error response

#Create analytics dashboard

#Parameters

#Request body

#Response

#Error response

#Generate a widget agent summary

#Parameters

path parameters

#Request body

#Response

#Error response

#Update analytics dashboard

#Parameters

path parameters

#Request body

#Response

#Error response

#Delete analytics dashboard

#Parameters

path parameters

#Response

#Error response