Voice Agent Analytics

Agent Analytics

Changed on

Agent Analytics

Everything the agent analytics view shows for one agent over a date range: headline numbers with an optional comparison to the previous period, a daily series, audience (locations, devices, traffic sources), leads, handoffs, action items, engagement, sentiment, topics, end reasons, satisfaction, call timing, languages and web versus phone. The response payload sits directly on data, not nested under a named key.

Leave out start for all time. A start more than 5 years before end is moved up to 5 years before end. A start after end returns 400. Rates are fractions from 0 to 1.

get/voice/analytics/agent

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/voice/analytics/agent
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Query parameters

agentIdstring required

The agent to report on. Required. Must be an agent in your workspace, otherwise the request returns 404.

startstring date-time

Start of the window, as an ISO 8601 date. Optional. Leave it out for all time.

endstring date-time

End of the window, as an ISO 8601 date. Optional. Defaults to now.

tzstring

IANA time zone used to bucket days, hours and weekdays, such as America/Toronto. Optional. Defaults to UTC. At most 100 characters. An unknown zone returns 400.

compareboolean

Also return the same numbers for the period of equal length just before start, in previousKpis. Optional. Defaults to false. Has no effect without start.

includeTestsboolean

Count test calls placed from the dashboard. Optional. Defaults to false. testCalls.count reports them either way.

Response

OK

status'success'

Changes