Query Region Quality Real-time Data

Description

This interface can be used to get the quality data within the specified time period in the last 1 hour for the specified region (or all regions) and specified platform (or all platforms). The data granularity is minutes.

Request method and endpoint

Request method: GET
Request URL: https://analytics-api.zego.im/?Action=GetRegionQualityDetail
Transfer protocol: HTTPS
QPS limit (same AppID): 3 times/minute, 480 times/day
Data delay: 3 minutes

Request parameters

The following request parameter list only lists the interface request parameters and some common parameters. Please refer to Accessing Server APIs - Public Request Parameters for the complete common parameter list.

Parameter	Type	Required	Description
Region	String	No	The name of the country or region. all: Default value, indicating all countries and regions.
Platform	String	No	Platform type. all: Default value, indicating all platforms. native: Native platform (excluding Web and mini-programs). web: Web and mini-programs. Warning Some indicators may not support the platform type dimension, and the return value may be empty.
StartTs	Number	Yes	Start time, UTC timestamp in milliseconds.
EndTs	Number	Yes	End time, UTC timestamp in milliseconds. If the push stream is not ended, it can be represented as 0 or the current timestamp to indicate in progress.

Request Example

https://analytics-api.zego.im/?Action=GetRegionQualityDetail
&Region=China
&Platform=all
&StartTs=1659411617260000
&EndTs=1659415320000
&<Public Request Parameters>

https://analytics-api.zego.im/?Action=GetRegionQualityDetail
&Region=China
&Platform=all
&StartTs=1659411617260000
&EndTs=1659415320000
&<Public Request Parameters>

Response Parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Operation result description.
RequestId	String	Request ID.
Data	Object	Response data.
└List	Array of Object	Metric list.
└Timestamp	Number	UTC timestamp in milliseconds.
└QualityInfo	Array of Object	Quality list.
└Region	String	The name of the country or region.
└P2pDelayDetail	Object	End-to-end delay.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples in the interval (0, 400ms).
└Rate2	Number	Percentage of samples in the interval [400ms, 600ms).
└Rate3	Number	Percentage of samples in the interval [600ms, 800ms).
└Rate4	Number	Percentage of samples in the interval [800ms, +∞).
└P2pPlrDetail	Array of Object	End-to-end packet loss rate distribution.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples with a packet loss rate of 0.
└Rate2	Number	Percentage of samples with a packet loss rate in the interval (0, 5%).
└Rate3	Number	Percentage of samples with a packet loss rate in the interval [5%, 10%).
└Rate4	Number	Percentage of samples with a packet loss rate in the interval [10%, 50%).
└Rate5	Number	Percentage of samples with a packet loss rate in the interval [50%, 100%].
└VideoBreakDetail	Array of Object	Video stutter rate distribution.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples with a stutter rate of 0.
└Rate2	Number	Percentage of samples with a stutter rate in the interval (0, 20%).
└Rate3	Number	Percentage of samples with a stutter rate in the interval [20%, 50%).
└Rate4	Number	Percentage of samples with a stutter rate in the interval [50%, 100%).
└Rate5	Number	Percentage of samples with a stutter rate in the interval [100%, +∞).
└AudioBreakDetail	Array of Object	Audio stutter rate distribution.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples with a stutter rate of 0.
└Rate2	Number	Percentage of samples with a stutter rate in the interval (0, 20%).
└Rate3	Number	Percentage of samples with a stutter rate in the interval [20%, 50%).
└Rate4	Number	Percentage of samples with a stutter rate in the interval [50%, 100%).
└Rate5	Number	Percentage of samples with a stutter rate in the interval [100%, +∞).
└LoginSuccessRateDetail	Array of Object	Login success rate.
└LoginSuccessRate	Number	Login success rate.
└LoginSuccessRate5s	Number	Login success rate in 5 seconds.
└VideoFFTDetail	Array of Object	Video first frame time distribution.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples with a time in the interval (0, 500ms].
└Rate2	Number	Percentage of samples with a time in the interval (500ms, 1000ms].
└Rate3	Number	Percentage of samples with a time in the interval (1000ms, 2000ms].
└Rate4	Number	Percentage of samples with a time in the interval (2000, 5000ms].
└Rate5	Number	Percentage of samples with a stutter rate in the interval [5000ms, +∞).
└AudioFFTDetail	Array of Object	Audio first frame time distribution.
└Total	Number	Total number of minutes samples.
└Rate1	Number	Percentage of samples with a time in the interval (0, 500ms].
└Rate2	Number	Percentage of samples with a time in the interval (500ms, 1000ms].
└Rate3	Number	Percentage of samples with a time in the interval (1000ms, 2000ms].
└Rate4	Number	Percentage of samples with a time in the interval (2000, 5000ms].
└Rate5	Number	Percentage of samples with a stutter rate in the interval [5000ms, +∞).

Response Example

{
  "Code": 0,
  "Data": {
    "List": [
      {
        "Timestamp": 1676961480000,
        "QualityInfo": [
          {
            "Region": "China",
            "P2pDelayDetail": {
              "Total": 298,
              "Rate1": 0.9966,
              "Rate2": 0,
              "Rate3": 0,
              "Rate4": 0.0034
            },
            "P2pPlrDetail": {
              "Total": 1123,
              "Rate1": 0.9386,
              "Rate2": 0.0561,
              "Rate3": 0.0018,
              "Rate4": 0.0036,
              "Rate5": 0
            },
            "VideoBreakDetail": {
              "Total": 920,
              "Rate1": 0.9304,
              "Rate2": 0.0022,
              "Rate3": 0.0109,
              "Rate4": 0.0446,
              "Rate5": 0.012
            },
            "AudioBreakDetail": {
              "Total": 1123,
              "Rate1": 0.951,
              "Rate2": 0.016,
              "Rate3": 0.0107,
              "Rate4": 0.0098,
              "Rate5": 0.0125
            },
            "LoginSuccessRateDetail": {
              "LoginSuccessRate": 1,
              "LoginSuccessRate5s": 1
            },
            "VideoFFTDetail": {
              "Total": 39,
              "Rate1": 0.9231,
              "Rate2": 0,
              "Rate3": 0.0513,
              "Rate4": 0.0256,
              "Rate5": 0
            },
            "AudioFFTDetail": {
              "Total": 36,
              "Rate1": 0.9167,
              "Rate2": 0.0278,
              "Rate3": 0.0556,
              "Rate4": 0,
              "Rate5": 0
            }
          }
        ]
      },
      {
        "Timestamp": 1676961540000,
        "QualityInfo": [
          {
            "Region": "China",
            "P2pDelayDetail": {
              "Total": 298,
              "Rate1": 0.9966,
              "Rate2": 0,
              "Rate3": 0,
              "Rate4": 0.0034
            },
            "P2pPlrDetail": {
              "Total": 1123,
              "Rate1": 0.9386,
              "Rate2": 0.0561,
              "Rate3": 0.0018,
              "Rate4": 0.0036,
              "Rate5": 0
            },
            "VideoBreakDetail": {
              "Total": 920,
              "Rate1": 0.9304,
              "Rate2": 0.0022,
              "Rate3": 0.0109,
              "Rate4": 0.0446,
              "Rate5": 0.012
            },
            "AudioBreakDetail": {
              "Total": 1123,
              "Rate1": 0.951,
              "Rate2": 0.016,
              "Rate3": 0.0107,
              "Rate4": 0.0098,
              "Rate5": 0.0125
            },
            "LoginSuccessRateDetail": {
              "LoginSuccessRate": 1,
              "LoginSuccessRate5s": 1
            },
            "VideoFFTDetail": {
              "Total": 39,
              "Rate1": 0.9231,
              "Rate2": 0,
              "Rate3": 0.0513,
              "Rate4": 0.0256,
              "Rate5": 0
            },
            "AudioFFTDetail": {
              "Total": 36,
              "Rate1": 0.9167,
              "Rate2": 0.0278,
              "Rate3": 0.0556,
              "Rate4": 0,
              "Rate5": 0
            }
          }
        ]
      }
    ]
  },
  "Message": "success"
}

{
  "Code": 0,
  "Data": {
    "List": [
      {
        "Timestamp": 1676961480000,
        "QualityInfo": [
          {
            "Region": "China",
            "P2pDelayDetail": {
              "Total": 298,
              "Rate1": 0.9966,
              "Rate2": 0,
              "Rate3": 0,
              "Rate4": 0.0034
            },
            "P2pPlrDetail": {
              "Total": 1123,
              "Rate1": 0.9386,
              "Rate2": 0.0561,
              "Rate3": 0.0018,
              "Rate4": 0.0036,
              "Rate5": 0
            },
            "VideoBreakDetail": {
              "Total": 920,
              "Rate1": 0.9304,
              "Rate2": 0.0022,
              "Rate3": 0.0109,
              "Rate4": 0.0446,
              "Rate5": 0.012
            },
            "AudioBreakDetail": {
              "Total": 1123,
              "Rate1": 0.951,
              "Rate2": 0.016,
              "Rate3": 0.0107,
              "Rate4": 0.0098,
              "Rate5": 0.0125
            },
            "LoginSuccessRateDetail": {
              "LoginSuccessRate": 1,
              "LoginSuccessRate5s": 1
            },
            "VideoFFTDetail": {
              "Total": 39,
              "Rate1": 0.9231,
              "Rate2": 0,
              "Rate3": 0.0513,
              "Rate4": 0.0256,
              "Rate5": 0
            },
            "AudioFFTDetail": {
              "Total": 36,
              "Rate1": 0.9167,
              "Rate2": 0.0278,
              "Rate3": 0.0556,
              "Rate4": 0,
              "Rate5": 0
            }
          }
        ]
      },
      {
        "Timestamp": 1676961540000,
        "QualityInfo": [
          {
            "Region": "China",
            "P2pDelayDetail": {
              "Total": 298,
              "Rate1": 0.9966,
              "Rate2": 0,
              "Rate3": 0,
              "Rate4": 0.0034
            },
            "P2pPlrDetail": {
              "Total": 1123,
              "Rate1": 0.9386,
              "Rate2": 0.0561,
              "Rate3": 0.0018,
              "Rate4": 0.0036,
              "Rate5": 0
            },
            "VideoBreakDetail": {
              "Total": 920,
              "Rate1": 0.9304,
              "Rate2": 0.0022,
              "Rate3": 0.0109,
              "Rate4": 0.0446,
              "Rate5": 0.012
            },
            "AudioBreakDetail": {
              "Total": 1123,
              "Rate1": 0.951,
              "Rate2": 0.016,
              "Rate3": 0.0107,
              "Rate4": 0.0098,
              "Rate5": 0.0125
            },
            "LoginSuccessRateDetail": {
              "LoginSuccessRate": 1,
              "LoginSuccessRate5s": 1
            },
            "VideoFFTDetail": {
              "Total": 39,
              "Rate1": 0.9231,
              "Rate2": 0,
              "Rate3": 0.0513,
              "Rate4": 0.0256,
              "Rate5": 0
            },
            "AudioFFTDetail": {
              "Total": 36,
              "Rate1": 0.9167,
              "Rate2": 0.0278,
              "Rate3": 0.0556,
              "Rate4": 0,
              "Rate5": 0
            }
          }
        ]
      }
    ]
  },
  "Message": "success"
}

Return Code

Return Code	Description	Action
0	Success.	-
500	Interface error.	Contact ZEGOCLOUD Technical Support.
10001	Parameter format error.	Check parameters.
10002	Parameter error or parameter invalid.	Check parameters.
30002	Interface request frequency exceeds the limit.	Please confirm the QPS limit of the corresponding interface and reduce the request frequency.