Advanced analytics is a feature that provides greater insight into users, messages, and channels. It can help you better analyze and understand user behavior in your Sendbird application. Advanced analytics offers immediate access to all metrics aggregated from your application, enabling more relevant and pragmatic insights. You can monitor the metrics both through Chat Platform API and in the Sendbird Dashboard.
The following table shows the list of properties in an advanced analytics resource.
The data types to retrieve metrics on. This property can have a value of the following types: channel_type, custom_channel_type, and custom_message_type.
The date of the retrieved metric value. If the time_dimension is daily, the format of the value is YYYY-MM-DD. If it is monthly, the format is YYYY-MM.
The value of a specified metric_type in the given time range. If the segment parameter is specified, this property represents the value of the specified metric_type on the specified segment data type for the given time range.
The channel type of each value. When the metric_type is specified as messages and the segments as channel_type, each value will include the channel_type property, which indicates how many messages have been created in which channel type. The values for this property can be open channel, public group channel, and private group channel.
The custom channel type of each value. When the metric_type is specified as either messages or created_channels and the segments as custom_channel_type, each value will include the custom_channel_type property, which indicates which custom channel type those messages or channels belong to.
The custom message type of each value. When the metric_type is specified as messages and the segments as custom_message_type, each value will include the custom_message_type property, which indicates which custom message type those messages belong to.
API endpoints are relative to the base URL allocated to your Sendbird application. In this page, the
/statisticsendpoint refers to
It’s recommended that the parameter values in API URLs be urlencoded, such as
Sendbird's Advanced analytics depicts user behavior through nine metrics: messages, messages per user, new channels, active channels, message senders, message viewers, new users, deactivated users, and deleted users. These advanced, accurate, and timely metrics in Advanced analytics can facilitate better-informed decision making, thus improving your client app’s user experience.
The total number of sent messages.
The average number of sent messages per user.
The total number of new channels.
The total number of channels where at least one message has been sent.
The total number of users that had sent at least one message.
The total number of users who have viewed at least one message. The value will be deduplicated based on the user ID.
The total number of new users.
The total number of users who were deactivated and denied access to your Sendbird application.
The total number of deleted users.
Note: Advanced analytics metrics can be retrieved from March 1, 2020 00:00 (UTC) and onwards except for the message_viewers metric. An empty list returns if a date range before this period is set or if no metrics can be found in the database table. If a requested date range includes an unsupported period, which is before March 1, 2020 00:00 (UTC), only metrics for the supported period will return.
The messages and created_channels metrics can be segmented, meaning data can be divided and grouped by channel type, custom channel type, and custom message type. Segmentation helps narrow the result scope and offers a closer look at user behavior in each data type. In addition, time-based segmentation can be applied by day or month.
Note: Segmentation can be applied up to 200 custom channel types or 200 custom message types only. If the number exceeds 200, Platform API returns a response body containing values only for the channels or messages whose custom type has a value of null. Meanwhile, specifying segments for other seven metrics may return an error. Refer to the response body sample at the bottom of this page.
You should specify time_dimension to retrieve data for a specific metric. Most data is retrieved in a daily format, but two metrics of Advanced analytics, which are message_senders and active_channels, support a longer time range for a more comprehensive view on user and channel activities. When using these two metrics, the value of time_dimension can be either daily or monthly.
Retrieves Advanced analytics metrics based on the specified parameters. You can retrieve either daily or monthly metrics using the time_dimension parameter.
Note: Daily metrics are calculated and updated every three hours, starting at 1 a.m. in UTC. Meanwhile, monthly metrics are calculated after the last day of the month.
The following table lists the parameters that this action supports.
Specifies a metric to retrieve, in accordance with the required and optional parameters. Acceptable values are:
Specifies the time range of the metric in detail. Acceptable values are either daily or monthly. For both daily and monthly metrics, time_dimension should be specified in conjunction with the start_year, end_year, start_month, and end_month. However, when the value is daily, start_day and end_day should be specified as well.
Specifies the start year of the metric’s time range, in YYYY format.
Specifies the end year of the metric’s time range, in YYYY format.
Specifies the start month of the metric’s time range as an integer from 1 to 12, inclusive.
Specifies the end month of the metric’s time range as an integer from 1 to 12, inclusive.
Specifies the number of results to return per page. Acceptable values are 1 to 1,000, inclusive. (Default: 1,000)
Specifies a page token that indicates the starting index of a chunk of results to retrieve. If not specified, the index is set as 0.
Specifies a data type to retrieve the metrics on. Acceptable values are channel_type, custom_channel_type, and custom_message_type. These values are effective only when the metric_type is either messages and created_channels.
Specifies the start day of the metric’s time range as an integer from 1 to 31, inclusive. This parameter should be specified in conjunction with the time_dimension and is required only when the time_dimension is daily.
Specifies the end day of the metric’s time range as an integer from 1 to 31, inclusive. This parameter should be specified in conjunction with the time_dimension and is required only when the time_dimension is daily.
Determines whether to export the metric as a CSV file instead of including it in the response. If set to true, the response includes the URL to download the exported file. (Default: false)
Query string example
If successful, this action returns a list of Advanced analytics data in the response body.
Note: If the number of custom channel types or custom message types exceeds 200, this action returns in the response body the values only for those whose custom_channel_type or custom_message_type has a value of null.
Also when the export_as_csv parameter is set to true, the response body includes an URL for the file. Meanwhile, specifying segments for other seven metrics may return an error.
When the metric_type is messages and segments is channel_type, the values will include information on which channel type the data belong to.
Status: 200 OK
A retrieved metric.
An array of one or more data types that are retrieved on the metrics.
A list of Advanced analytics data that match the specified parameters.
The value for the token parameter to retrieve the next page in the result set.