GET /analytics/overview
Updated Oct 1, 20261 minute read
Get the overview
The dashboard's headline numbers: open conversations, this week against last, satisfaction over the last 30 days, and open signals.
Part of Analytics.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
now | query | integer | No | Unix ms to anchor the windows on. Defaults to the server's clock. |
Responses
| Status | Description |
|---|---|
200 | The numbers. |
401 | The bearer token is missing, revoked, or expired. |
429 | Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits. |
200 body
| Field | Type | Required | Description |
|---|---|---|---|
openConversations | integer | No | |
openCapped | boolean | No | |
thisWeek | integer | No | |
lastWeek | integer | No | |
weekByDay | integer[] | No | |
csatAverage | any | No | |
csatCount | integer | No | |
openSignals | integer | No |
Example request
curl https://api.median.sh/v1/analytics/overview \
-H "Authorization: Bearer $BEARER_AUTH"