← Back to API Reference overview

Analytics Dashboard

Endpoints for managing analytics dashboards with flexible, config-driven widgets. Each widget defines its own data source and visualization.

Shortcut: ⌘K

#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

id

string

sender

string

"user" or "assistant"

text

string

timestamp

string (date-time)
GET/v1/analytics/dashboardsRequires auth

#List analytics dashboards

#Parameters

This endpoint does not accept any parameters.

#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.

POST/v1/analytics/dashboardsRequires auth

#Create analytics dashboard

#Parameters

This endpoint does not accept any parameters.

#Request body

No structured schema available for this section.

#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.

PUT/v1/analytics/dashboardRequires auth

#Update analytics dashboard

#Parameters

This endpoint does not accept any parameters.

#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.

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

#Delete analytics dashboard

Delete a dashboard and its associated AI conversation.

#Parameters

path parameters

id

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.