Live Statistics Data Callback Notification
Updated: 2026-02-24 17:00:24
Usage Instructions and Recommendations
- To enable this feature, please contact customer service.
- It is recommended to use this feature for retrieving statistical data only when the volume of live statistics is large. For example, when a single live broadcast has over 10,000 records of "channel viewing details data".
- For smaller data volumes, it is recommended to use regular API queries for data retrieval, as they are more flexible.
Function
After setting the callback interface address, when a live broadcast under your account ends, the relevant live statistics data will be packaged, and the channel ID along with the download URL for the statistics data file will be sent as a callback notification via POST.
Callback Parameter Description
| Parameter Name | Type | Description |
|---|---|---|
| channelId | String | Channel ID |
| liveStatsFileUrl | String | Download URL for the live statistics data file. This URL is valid for 7 days from the time of the callback notification and will expire and become inaccessible after 7 days. |
| timestamp | Long | 13-digit timestamp |
| sign | String | Encrypted string for verification. The generation rule is md5(AppSecret+timestamp), where AppSecret is the secret key of the live streaming system. |
Live Statistics Data File Format Description
File URL example: https://doc-oss.polyv.net/export/abcd1234/live-stats-channel-123456-123.zip
The file is a zip archive. The files contained within the archive are all in JSON format, and their content format is consistent with the response content of a specific API. Each type of data includes the data for the live channel on the current day (up to the time the file was generated). Details are as follows:
| JSON Data File | Data Description | JSON File Content, Refer to the Response Data Format of This API |
|---|---|---|
| channel-session.json | Channel session data | Query Channel Session Information |
| channel-viewlog-xxx.json | Channel viewing details data. Each file contains a maximum of 10,000 records. If there are more than 10,000 records, the data will be split into multiple files. The file names end with a 3-digit sequence number starting from 001, e.g., channel-viewlog-001.json, channel-viewlog-002.json. | Paginated Query of Account Live Viewing Details Data |
| channel-checkin-xxx.json | Channel check-in success data. File splitting rules are the same as above. | Query Channel Check-in Success Records |
| channel-chat-content-xxx.json | Channel chat data. File splitting rules are the same as above. | Query Channel Chat Records |
