Get a dashboard
GET/analytics/dashboards/:dashboard_id
A dashboard with its graphs, and optionally their current values.
Without include=values this is a cheap metadata read. With it, every graph is
executed and gains a value object holding the same series and totals the
console renders — up to 30 graphs per call, with values_truncated_after in the
response if the dashboard has more.
Running the graphs is genuinely expensive. Cache the result rather than polling it, and prefer a schedule measured in minutes over one measured in seconds.
One caveat: a graph filtered to "my conversations" resolves $AGENT_ID against
the caller, and a machine credential is nobody in particular — such a graph
legitimately comes back empty here.
Request
Responses
- 200
- 401
- 403
- 404
- 503
The dashboard.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
A dependency is temporarily unavailable, or a required index is still building. Safe to retry.
Response Headers
Correlation id for this request. Quote it when reporting a problem.