Statistics

Generates a channel-specific report

get

Required Permission: chatbots.statistics.get

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

Query parameters

channelIdstringRequired

The Id of the channel for which to retrieve statistics for.

fromstringRequired

The start date of the statistics timeframe (ISO format).

Example: 2025-01-04T23:00:00.000Z

tostringRequired

The end date of the statistics timeframe (ISO format).

Example: 2025-02-01T22:59:59.999Z

intervalnumber · enumRequired

Sets the interval per day or hour in seconds (86400 for multiple days reports and 3600 for single day reports)

Possible values:

componentsstringRequired

Comma-separated list of component IDs.

0: STEP_EXEC_COUNT_FOR_CHANNEL_ID
1: CONVERSATION_COUNT_FOR_CHANNEL_ID
2: CONVERSATION_COUNT_INTERVAL_FOR_CHANNEL_ID
3: CONVERSATION_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID
4: CONVERSATION_LANGUAGES_FOR_CHANNEL_ID
5: CONVERSATION_MESSAGE_COUNT_MEDIAN_FOR_CHANNEL_ID
6: INTENT_COUNT_FOR_CHANNEL_ID
7: INTENT_HITS_FOR_CHANNEL_ID
8: INTENT_SCORE_MEDIAN_FOR_CHANNEL_ID
9: INTERACTION_COUNT_FOR_CHANNEL_ID
10: INTERACTION_COUNT_INTERVAL_FOR_CHANNEL_ID
11: INTERACTION_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID
12: MESSAGE_COUNT_FOR_CHANNEL_ID
13: MESSAGE_COUNT_INTERVAL_FOR_CHANNEL_ID
14: MESSAGE_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID
15: MESSAGE_LENGTH_MEDIAN_FOR_CHANNEL_ID
16: CALL_DURATION_TOTAL
17: CALL_DURATION_PERIODIC_TREND
18: CALL_DURATION_MEDIAN
19: CALL_EXIT_STEP
20: CALL_USER_INPUTS_MEDIAN
21: CALL_END_REASON
22: CALL_TRANSFER_TARGET

Example: 0,1,2

Responses

200

The report structure depends on the requested components.

application/json

objectOptional

get

/v1/chatbots/{chatbotId}/statistics/reports/channel

GET /v1/chatbots/{chatbotId}/statistics/reports/channel?channelId=text&from=2025-01-04T23%3A00%3A00.000Z&to=2025-02-01T22%3A59%3A59.999Z&interval=86400&components=0%2C1%2C2 HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

200

The report structure depends on the requested components.

{}

Generates an overview report

get

Required Permission: chatbots.statistics.get

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

Query parameters

fromstringRequired

The start date of the statistics timeframe (ISO format).

Example: 2025-01-04T23:00:00.000Z

tostringRequired

The end date of the statistics timeframe (ISO format).

Example: 2025-02-01T22:59:59.999Z

intervalnumber · enumRequired

Sets the interval per day or hour in seconds (86400 for multiple days reports and 3600 for single day reports)

Possible values:

componentsstringRequired

Comma-separated list of component IDs.

0: STEP_EXEC_COUNT
1: CONVERSATION_COUNT
2: CONVERSATION_COUNT_INTERVAL
3: CONVERSATION_LANGUAGES
4: CONVERSATION_BY_CHANNEL_TYPE
5: CONVERSATION_COUNT_PERIODIC_TREND
6: CONVERSATION_MESSAGE_COUNT_MEDIAN
7: MESSAGE_COUNT
8: MESSAGE_COUNT_INTERVAL
9: MESSAGE_COUNT_PERIODIC_TREND
10: MESSAGE_LENGTH_MEDIAN
11: INTENT_HITS
12: INTENT_SCORE_MEDIAN
13: INTENT_COUNT
14: INTERACTION_COUNT
15: INTERACTION_COUNT_INTERVAL
16: INTERACTION_COUNT_PERIODIC_TREND

Example: 0,1,2

Responses

200

The report structure depends on the requested components.

application/json

objectOptional

get

/v1/chatbots/{chatbotId}/statistics/reports/overview

GET /v1/chatbots/{chatbotId}/statistics/reports/overview?from=2025-01-04T23%3A00%3A00.000Z&to=2025-02-01T22%3A59%3A59.999Z&interval=86400&components=0%2C1%2C2 HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

200

The report structure depends on the requested components.

{}

Creates an export of statistics

post

Required Permission: chatbots.statistics.export

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

Query parameters

fromstringRequired

The start date of the statistics timeframe (ISO format).

Example: 2025-01-04T23:00:00.000Z

tostringRequired

The end date of the statistics timeframe (ISO format).

Example: 2025-02-01T22:59:59.999Z

Responses

202

Export job has been started.

application/json

post

/v1/chatbots/{chatbotId}/statistics/export

POST /v1/chatbots/{chatbotId}/statistics/export?from=2025-01-04T23%3A00%3A00.000Z&to=2025-02-01T22%3A59%3A59.999Z HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

202

Export job has been started.

{
  "exportId": "stsXOuKC7E4oNjym4Uy1",
  "error": "text"
}

Retrieves the status of a statistics export

get

Required Permission: chatbots.statistics.export

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

exportIdstringRequired

The Id of the export job.

Responses

200

The current status of the export job.

application/json

statusstringRequired

The status of the export.

Example: completed

downloadUrlstringOptional

URL to download the file when the export is completed.

Example: https://storage.googleapis.com/exports/export-123.csv

errorstringOptional

Optional error message.

get

/v1/chatbots/{chatbotId}/statistics/export/{exportId}

GET /v1/chatbots/{chatbotId}/statistics/export/{exportId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

200

The current status of the export job.

{
  "status": "completed",
  "downloadUrl": "https://storage.googleapis.com/exports/export-123.csv",
  "error": "text"
}

Retrieves statistics of the inbox section of a chatbot.

get

Required Permission: chatbots.statistics.get

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

Query parameters

fromstringRequired

The start date of the statistics timeframe (ISO format).

Example: 2025-01-04T23:00:00.000Z

tostringRequired

The end date of the statistics timeframe (ISO format).

Example: 2025-02-01T22:59:59.999Z

Responses

200

The inbox statistics data.

application/json

errorstringOptional

Optional error message.

get

/v1/chatbots/{chatbotId}/statistics/inbox

GET /v1/chatbots/{chatbotId}/statistics/inbox?from=2025-01-04T23%3A00%3A00.000Z&to=2025-02-01T22%3A59%3A59.999Z HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

200

The inbox statistics data.

{
  "data": {
    "transferredToAgentCount": 150,
    "conversationAcceptedCount": 120,
    "conversationNotAcceptedCount": 30,
    "averageJoinTimeSeconds": 60,
    "agentPerformance": [
      {
        "operatorId": "op_abc123xyz",
        "acceptedCount": 25,
        "avgJoinTimeSeconds": 45.5,
        "operatorName": "John Doe"
      }
    ]
  },
  "error": "text"
}

Retrieves all channels associated with a chatbot

get

Required Permission: chatbots.statistics.get

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot

Responses

200

The list of channels for the chatbot.

application/json

500

Internal server error, e.g. if the channel service is unavailable.

get

/v1/chatbots/{chatbotId}/statistics/channels

GET /v1/chatbots/{chatbotId}/statistics/channels HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "channels": [
    {
      "channelId": "656DSztzc13rF",
      "channelName": "Web Support",
      "channelType": "voice"
    }
  ]
}

PreviousInbox widgets NextStorage objects

Last updated 6 days ago