https://api.chat-data.com/Get the aggregated statistics of a chatbot.
chatbotIdstringcurl 'https://api.chat-data.com/api/v2/get-analysis/6650f1c2a9e4b83d2c7a1f05' \ -H "Authorization: Bearer $CHAT_DATA_API_KEY"Content type: application/json
| Field | Type | Description |
|---|---|---|
| statusstring | string | One of: success. |
| countryDistributionarray of object | array of object | Messages per user country, most messages first. |
| countryDistribution | string | The 2-letter ISO country code from the IP address lookup (Unknown when it could not be resolved). |
| countryDistribution | number | The number of messages for users from this country within the specified date range. |
| hourDistributionarray of object | array of object | Messages per UTC hour and source, ordered by hour. |
| hourDistribution | string | The UTC hour when the messages occurred. |
| hourDistribution | string | The source of the messages. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| hourDistribution | number | The number of messages during this UTC hour within the specified date range. |
| creditsDistributionarray of object | array of object | One entry per day and source, oldest first. |
| creditsDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| creditsDistribution | string | The source where message credits were consumed. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| creditsDistribution | number | The number of message credits consumed on the specified date. |
| messagesDistributionarray of object | array of object | One entry per day and source, oldest first. |
| messagesDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| messagesDistribution | string | The source where the messages were sent. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| messagesDistribution | number | The number of messages sent on the specified date. |
| liveChatEmails | array of object | One entry per day and source, oldest first. |
| liveChatEmails | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| liveChatEmails | string | The source where the live chat emails were sent. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| liveChatEmails | number | The number of live chat emails sent on the specified date. |
| liveChatSmsDistributionarray of object | array of object | One entry per day and source, oldest first. |
| liveChatSmsDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| liveChatSmsDistribution | string | The source where the live chat SMS messages were sent. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| liveChatSmsDistribution | number | The number of live chat SMS messages sent on the specified date. |
| liveChatEscalations | array of object | One entry per day and source, oldest first. |
| liveChatEscalations | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| liveChatEscalations | string | The source where the live chat escalations happened. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| liveChatEscalations | number | The number of live chat escalations on the specified date. |
| upVotesDistributionarray of object | array of object | One entry per day and source, oldest first. |
| upVotesDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| upVotesDistribution | string | The source where the upvotes occurred. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| upVotesDistribution | number | The number of upvotes on the specified date. |
| downVotesDistributionarray of object | array of object | One entry per day and source, oldest first. |
| downVotesDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| downVotesDistribution | string | The source where the downvotes occurred. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| downVotesDistribution | number | The number of downvotes on the specified date. |
| conversations | array of object | One entry per day and source, oldest first. |
| conversations | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| conversations | string | The source where the conversations started. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| conversations | number | The number of conversations started on the specified date. |
| leadsCountDistributionarray of object | array of object | One entry per day and source, oldest first. |
| leadsCountDistribution | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| leadsCountDistribution | string | The source where the leads were collected. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| leadsCountDistribution | number | The number of leads collected on the specified date. |
| workflowEmails | array of object | One entry per day and source, oldest first. |
| workflowEmails | number | The day, as a timestamp in milliseconds since the Unix epoch. |
| workflowEmails | string | The source where the workflow emails were sent. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger, youtube-transcription, image-description-test, metering. |
| workflowEmails | number | The number of workflow emails sent on the specified date. |
| topicsDistributionarray of object | array of object | Totals per topic, highest count first. |
| topicsDistribution | string | The topic name. |
| topicsDistribution | number | The number of user messages classified with this topic. |
| sentimentsDistributionarray of object | array of object | Totals per sentiment, highest count first. |
| sentimentsDistribution | string | The sentiment value (for example positive, negative or neutral). |
| sentimentsDistribution | number | The number of user messages classified with this sentiment. |
| ratingDistributionarray of object | array of object | Totals per rating, highest count first. |
| ratingDistribution | string | The rating value (1-5). |
| ratingDistribution | number | The number of conversations with this rating. |
Example
{ "status": "success", "countryDistribution": [ { "country": "US", "count": 184 }, { "country": "GB", "count": 61 } ], "hourDistribution": [ { "hour": "14", "source": "iframe", "count": 37 }, { "hour": "15", "source": "iframe", "count": 29 } ], "creditsDistribution": [ { "date": 1791849600000, "source": "api", "count": 96 }, { "date": 1791936000000, "source": "iframe", "count": 412 } ], "messagesDistribution": [ { "date": 1791849600000, "source": "api", "count": 88 }, { "date": 1791936000000, "source": "iframe", "count": 356 } ], "liveChatEmailsDistribution": [ { "date": 1791849600000, "source": "api", "count": 1 }, { "date": 1791936000000, "source": "iframe", "count": 3 } ], "liveChatSmsDistribution": [ { "date": 1791849600000, "source": "api", "count": 0 }, { "date": 1791936000000, "source": "iframe", "count": 2 } ], "liveChatEscalationsDistribution": [ { "date": 1791849600000, "source": "api", "count": 1 }, { "date": 1791936000000, "source": "iframe", "count": 4 } ], "upVotesDistribution": [ { "date": 1791849600000, "source": "api", "count": 6 }, { "date": 1791936000000, "source": "iframe", "count": 21 } ], "downVotesDistribution": [ { "date": 1791849600000, "source": "api", "count": 1 }, { "date": 1791936000000, "source": "iframe", "count": 4 } ], "conversationsDistribution": [ { "date": 1791849600000, "source": "api", "count": 14 }, { "date": 1791936000000, "source": "iframe", "count": 58 } ], "leadsCountDistribution": [ { "date": 1791849600000, "source": "api", "count": 2 }, { "date": 1791936000000, "source": "iframe", "count": 9 } ], "workflowEmailsDistribution": [ { "date": 1791849600000, "source": "api", "count": 1 }, { "date": 1791936000000, "source": "iframe", "count": 5 } ], "topicsDistribution": [ { "topic": "Pricing", "count": 26 }, { "topic": "Shipping", "count": 17 } ], "sentimentsDistribution": [ { "sentiment": "positive", "count": 41 }, { "sentiment": "neutral", "count": 12 } ], "ratingDistribution": [ { "rating": "5", "count": 19 }, { "rating": "4", "count": 7 } ]}Last updated October 14, 2026