Queries the distribution of users with abnormal events.
Function
Queries the distribution of call exception details of a specified app in a specified period.
The maximum query time span is one day.
URI
GET /v1/rtc/data/abnormal-event/dimension
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
app |
Yes |
String |
App ID |
room_id |
No |
String |
Room ID |
dimension |
No |
String |
Group type. Two types can be specified at the same time.
|
start_time |
No |
String |
Start time of the query (UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T06:00:00Z). If this parameter is not specified, the data of the last hour is read by default. |
end_time |
No |
String |
End time of the query (UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T07:00:00Z). If this parameter is not specified, the current time is used by default. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token, which is mandatory for token authentication. You can obtain the token by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique identifier of the request |
Parameter |
Type |
Description |
---|---|---|
dimensions |
Array of AbnormalEventDimensionValue objects |
List of abnormal experience events |
Parameter |
Type |
Description |
---|---|---|
abnormal_type |
Integer |
Type of an exception:
|
abnormal_type_desc |
String |
The exception type description corresponds to the exception type and supports internationalization. The options are as follows:
|
abnormal_factor |
Integer |
Abnormal factors When the exception type is 1, the value range of the exception factor is as follows:
When the exception type is 2 or 3, the options are as follows:
|
abnormal_factor_desc |
String |
Exception factor description, which supports internationalization. When the exception type is 1, the exception factor description corresponds to the exception factor. The options are as follows:
When the exception type is 2 or 3, the exception factor description corresponds to the exception factor. The options are as follows:
In other cases, the exception factor is described as Others. |
user_count |
Long |
Number of users affected by an exception |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique identifier of the request |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
GET /v1/rtc/data/abnormal-event/dimension?app=5f963b4c89ae1628c2568001&room_id=3b48d9db05cc11ecb1e78fe304a40b8f&start_time=2021-08-25T16:00:00Z&end_time=2021-08-25T18:00:00Z
Example Responses
Status code: 200
OK.
{ "dimensions" : [ { "abnormal_type" : 2, "abnormal_type_desc" : "Video freezing", "abnormal_factor" : 14, "abnormal_factor_desc" : "Downlink video packet loss", "user_count" : 1 }, { "abnormal_type" : 3, "abnormal_type_desc" : "Audio freezing", "abnormal_factor" : 13, "abnormal_factor_desc" : "Downlink audio packet loss", "user_count" : 1 } ] }
Status code: 400
Query failed.
{ "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK. |
400 |
Query failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot