Skip to main content
GET
/
api
/
dashboard
/
insights
Dashboard insights
curl --request GET \
  --url https://api.example.com/api/dashboard/insights \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "insight_type": "<string>",
      "message": "<string>",
      "value": 123,
      "trend": "<string>",
      "previous_value": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scope
enum<string> | null

Filter by scope (personal or work)

Available options:
personal,
work

Response

Successful Response

List response for insights endpoint.

items
InsightItem · object[]
required