Get the overview

The dashboard’s headline numbers: open conversations, this week against last, satisfaction over the last 30 days, and open signals.

GET/analytics/overview

Authorization

AuthorizationBearer token · headerrequired

`MEDIAN_KEY` from Settings under API, or an MCP OAuth access token. A key acts as the organization; a token acts as the person who approved it.

Query parameters

nowinteger

Unix ms to anchor the windows on. Defaults to the server's clock.

Responses

200The numbers.

openConversationsinteger

openCappedboolean

thisWeekinteger

lastWeekinteger

weekByDayinteger[]

csatAveragenumber | null

csatCountinteger

openSignalsinteger

401The bearer token is missing, revoked, or expired.

errorobject

Show properties

codestring

messagestring

429Too many requests. Wait the seconds in `Retry-After`. Limits depend on the plan. See [rate limits](/api/errors-and-limits#rate-limits).

errorobject

Show properties

codestring

messagestring

Request

curl -X GET "https://api.median.sh/v1/analytics/overview" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.median.sh/v1/analytics/overview", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "openConversations": 0,
  "openCapped": true,
  "thisWeek": 0,
  "lastWeek": 0,
  "weekByDay": [
    0
  ],
  "csatAverage": 0,
  "csatCount": 0,
  "openSignals": 0
}