Contents

API reference

Analytics

API reference descriptions are provided in English to preserve the exact published contract.

Query campaign results

GET /v1/accounts/{AC}/analytics/campaigns

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–10000)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query append-only agent or queue performance facts

GET /v1/accounts/{AC}/analytics/conversation-performance

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
dimensionquery · "agent" | "queue"yes
limitquery · integer (1–100)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query traffic by calling code

GET /v1/accounts/{AC}/analytics/countries

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–10000)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query top errors

GET /v1/accounts/{AC}/analytics/errors

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–10000)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query message analytics

GET /v1/accounts/{AC}/analytics/messages

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–10000)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query persisted reply attribution and response time

GET /v1/accounts/{AC}/analytics/replies

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–100)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Query webhook delivery reliability

GET /v1/accounts/{AC}/analytics/webhook-reliability

Required scope: `analytics:read`.

Parameters

Parameters
NameTypeRequiredDescription
fromquery · string (date-time)yes
toquery · string (date-time)yes
limitquery · integer (1–10000)
ACpath · string (AC… SID)yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.