Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Analytics

Retrieves periodic responder chat message volume analytics.

get/api/v1/analytics/periodic-responder-chat-message-volume

Query parameters

granularity'hourly' | 'daily' | 'weekly' | 'monthly' required
rangeEndstring date-time nullable
rangeStartstring date-time nullable

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Responder chat message volume analytics retrieved successfully.

channelIdstring required
channelNamestring required
channelType'api' | 'widget' | 'waha' | 'whatsapp' | 'instagram' | 'telegram' required
countinteger required
periodEndstring date-time required
periodStartstring date-time required
responderEntity'agents' | 'squads' required
responderIdstring required
responderNamestring required
responderPicturestring nullable required