Skip to main content
GET
Get agent performance analytics

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer with the Analytics READ scope.

Query Parameters

startAt
string<date-time>
required

Start of the reporting window (ISO 8601). Inclusive.

endAt
string<date-time>
required

End of the reporting window (ISO 8601). Inclusive.

sources
enum<string>

Optional channel filter. Accepts a single value. To combine channels, call the endpoint per channel and merge on your side.

Available options:
whatsapp,
whatsapp_cloud_api,
whatsapp_coex,
instagram,
facebook,
tiktok,
outlook,
widget
agentName
string

Case-insensitive substring match on the agent display name.

Response

Analytics records

status
string
Example:

"success"

data
object