Platform APIAnalytics

Export analytics data

Export analytics programmatically for blending with your BI dashboards or internal reporting tools. ### Troubleshooting * If you are not seeing data for a specific agent, double-check the model_id you are using. Make sure the agent is active. * Date range errors: limit the query to a maximum of 120 days. * Unauthorized API access: double-check your API key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

from_datestringOptionalformat: "date"
The start date for the date range for which you want to export analytics data. If you don't specify the date range, it'll default to the past 7 days. The maximum date range is 120 days.
to_datestringOptionalformat: "date"
The end date for the date range for which you want to export analytics data.
model_idstringOptional
If you want to export data for a specific agent, use its model ID. You can find it on the agent's page in your dashboard.
type_of_callenumOptional

Filter calls by agent type (inbound, outbound or widget).

Allowed values:

Response

200
executed_actionsobject or null
List of actions executed during the call, as well as their success and frequency rates.
assistant_performanceobject or null
Agent performance overview.
call_status_statobject or null
Call status overview.
recent_call_historyobject or null
Log of all recent calls.
duration_metricsobject or null
Duration metrics overview.
end_call_reason_statobject or null

An overview of reasons calls ended. For details on all the possible reasons, see End Call Reasons.

sentiment_statobject or null
Sentiment overview.