POST
Query Analytics

Authorizations

Authorization
string
header
required

Interactive user session: the login JWT, sent as Authorization: Bearer <token>.

Body

application/json
start
string<date-time>
required
end
string<date-time>
required
metric
string
required
breakdown
string | null
column_breakdown
string | null
granularity
string | null
workflow_id
integer | null
call_type
string | null
state
string | null
campaign_id
integer | null
dashboard
string
default:call
offset
integer
default:0
page_size
integer
default:50
sort_by
string | null
sort_dir
string
default:desc

Response

Successful Response

total
number
required
series
AnalyticsSeriesPoint ┬╖ object[]
required
matrix
AnalyticsMatrix ┬╖ object | null

One page of a crosstab.

Serialized in the camelCase the matrix renderer already consumes. Every total is computed server-side over the FULL filtered set тАФ the client must never derive one by summing cells, which holds one page of a possibly non-additive metric. On the in-memory path that set is the fetch, which can be clipped; the response's truncated flag is what says so.

page
AnalyticsPage ┬╖ object | null

Paging envelope for a bounded single-dimension breakdown.

truncated
boolean
default:false