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
getV1AccountsByAcAnalyticsCampaigns200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–10000) | | |
AC | path · 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
getV1AccountsByAcAnalyticsConversationPerformance200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
dimension | query · "agent" | "queue" | yes | |
limit | query · integer (1–100) | | |
AC | path · 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
getV1AccountsByAcAnalyticsCountries200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–10000) | | |
AC | path · 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
getV1AccountsByAcAnalyticsErrors200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–10000) | | |
AC | path · 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
getV1AccountsByAcAnalyticsMessages200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–10000) | | |
AC | path · 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
getV1AccountsByAcAnalyticsReplies200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–100) | | |
AC | path · 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
getV1AccountsByAcAnalyticsWebhookReliability200
Required scope: `analytics:read`.
Parameters
Parameters| Name | Type | Required | Description |
|---|
from | query · string (date-time) | yes | |
to | query · string (date-time) | yes | |
limit | query · integer (1–10000) | | |
AC | path · string (AC… SID) | yes | |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.