API Overview
ZEGOCLOUD Analytics Dashboard Server provides the following related API interfaces and callbacks, please refer to Accessing Server APIs to call the following interfaces.
Detailed Data
| Interface Function | Interface Description | Default Call Frequency Limit |
|---|---|---|
| Query User Push and Pull Stream Basic Information | Query the basic information related to the specified room ID and stream ID of the user within the specified time period. | 3 times/second, 10000 times/day |
| Query User Push Stream Quality and Performance Details | Query the push quality and device performance based on user ID, time period, room ID, and stream ID. | 3 times/second, 10000 times/day |
| Query User Pull Stream Quality and Performance Details | Query the pull quality and device performance based on user ID, time period, room ID, and stream ID. | 3 times/second, 10000 times/day |
Real-time Monitoring
| Interface Function | Interface Description | Default Call Frequency Limit |
|---|---|---|
| Query Regional Quality Real-time Data | Query the quality data within the last hour in the specified region (or all regions) and specified platform (or all platforms). | 3 times/minute, 480 times/day |
| Get Real-time Usage | Get the real-time push and pull stream concurrency, room concurrency, online user count, maximum room user count, and mixed stream concurrency in the last 2 hours. The data granularity is seconds. | 3 times/minute, 480 times/day |
| Get Real-time Quality | Get the real-time audio-video stutter rate, uplink and downlink latency, end-to-end delay, push and pull stream success rate, and room login success rate in the last 2 hours. The data granularity is seconds. | 3 times/minute, 480 times/day |
Operations Dashboard
| Interface Function | Interface Description | Default Call Frequency Limit |
|---|---|---|
| Get Business Usage | Query the real-time audio-video data statistics including room concurrency peak, user concurrency, push and pull stream concurrency, and cumulative total of push and pull streams within the specified time period. | 3 times/minute, 480 times/day |
| Get Quality Trends | Query the real-time audio-video quality indicators including stutter rate, first frame time, push success rate, pull success rate, room login success rate, and room login success rate within 5 seconds in the specified time period. | 3 times/minute, 480 times/day |