Skip to main content
GET
Get dashboard analytics

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Dashboard ID.

Query Parameters

range
enum<string>
default:30d
Available options:
7d,
14d,
30d,
90d
from
string

Inclusive ISO date or timestamp.

to
string

A date is inclusive; a timestamp is an exclusive boundary.

assistant_ids
string

Comma-separated assistant IDs (max 50).

campaign_ids
string

Comma-separated campaign IDs (max 50).

directions
string

Comma-separated call directions.

statuses
string

Comma-separated call statuses.

sentiments
string

Comma-separated post-call sentiments.

success
boolean
compare
boolean
default:true

Compare with the immediately preceding equal-length period.

Response

Dashboard analytics.

data
object
required