Analytics

get

Retrieves periodic responder chat message volume analytics.

Query parameters
granularitystring · enumRequiredPossible values:
rangeEndstring · date-time · nullableOptional
rangeStartstring · date-time · nullableOptional
Header parameters
authorizationstringRequired

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

Responses
200

Responder chat message volume analytics retrieved successfully.

application/json
channelIdstringRequired
channelNamestringRequired
channelTypestring · enumRequiredPossible values:
countintegerRequired
periodEndstring · date-timeRequired
periodStartstring · date-timeRequired
responderEntitystring · enumRequiredPossible values:
responderIdstringRequired
responderNamestringRequired
responderPicturestring · nullableRequired
get
/api/v1/analytics/periodic-responder-chat-message-volume
get

Retrieves periodic responder credit usage analytics.

Query parameters
granularitystring · enumRequiredPossible values:
rangeEndstring · date-time · nullableOptional
rangeStartstring · date-time · nullableOptional
Header parameters
authorizationstringRequired

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

Responses
200

Responder credit usage analytics retrieved successfully.

application/json
creditsnumberRequired
periodEndstring · date-timeRequired
periodStartstring · date-timeRequired
responderEntitystring · enumRequiredPossible values:
responderIdstringRequired
responderNamestringRequired
responderPicturestring · nullableRequired
get
/api/v1/analytics/periodic-responder-credit-usage
get

Retrieves periodic user chat message average analytics.

Query parameters
granularitystring · enumRequiredPossible values:
rangeEndstring · date-time · nullableOptional
rangeStartstring · date-time · nullableOptional
Header parameters
authorizationstringRequired

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

Responses
200

User chat message average analytics retrieved successfully.

application/json
averagenumberRequired
channelIdstringRequired
channelNamestringRequired
channelTypestring · enumRequiredPossible values:
periodEndstring · date-timeRequired
periodStartstring · date-timeRequired
responderEntitystring · enumRequiredPossible values:
responderIdstringRequired
responderNamestringRequired
responderPicturestring · nullableRequired
get
/api/v1/analytics/periodic-user-chat-message-average
get

Retrieves periodic user interactivity analytics.

Query parameters
granularitystring · enumRequiredPossible values:
rangeEndstring · date-time · nullableOptional
rangeStartstring · date-time · nullableOptional
Header parameters
authorizationstringRequired

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

Responses
200

User interactivity analytics retrieved successfully.

application/json
channelIdstringRequired
channelNamestringRequired
channelTypestring · enumRequiredPossible values:
countintegerRequired
periodEndstring · date-timeRequired
periodStartstring · date-timeRequired
get
/api/v1/analytics/periodic-user-interactivity

Last updated