Help Center/ SparkRTC/ API Reference/ Statistical Analysis/ Querying User Experience Exception Events (RCMS Service)
Updated on 2025-02-08 GMT+08:00
View PDF
Share

Querying User Experience Exception Events (RCMS Service)

Function

This API is used to query call exception details of a specified application. Data within five days can be queried.

URI

GET /v1/{project_id}/rtc/client/abnormalevent

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID.

room_id

No

String

Room ID.

start_time

Yes

String

Start time of the query (UTC time in the format of yyyy-mm-ddThh:mm:ssZ, for example, 2020-04-23T06:00:00Z). The query period cannot exceed one hour. The data of a single user in the past five days can be queried.

end_time

Yes

String

End time of the query (UTC time in the format of yyyy-mm-ddThh:mm:ssZ, for example, 2020-04-23T06:00:00Z). The query period cannot exceed one hour. The data of a single user in the past five days can be queried.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

X-Project-Id

No

String

Project ID, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique ID of the request.
Table 5 Response body parameters

Parameter

Type

Description

room_id

String

Room ID.

uid

String

User ID.

exp_id

String

Experience ID.

abnormal_list

Array of RTCCause objects

Exception information list. Note: This field may be null, indicating that no valid value is obtained.
Table 6 RTCCause

Parameter

Type

Description

ts

String

Timestamp of an exception event.

event_id

String

Exception event ID.

peer_id

String

Peer user ID.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique ID of the request.
Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET /v1/{project_id}/rtc/client/abnormalevent?app_id=5fa682b34a974f7ad24d223b&room_id=6951a79e9f811ebbd2ac58d7ac82553&start_time=2020-04-23T06:00:00Z&end_time=2020-04-23T07:00:00Z

Example Responses

Status code: 200

This status code is returned if the request succeeds.

{
  "uid" : "sfu-PLAYER-18708-2-1",
  "room_id" : "ddmax1000-2",
  "exp_id" : "954350051",
  "abnormal_list" : [ {
    "event_id" : "18",
    "peer_id" : "w138",
    "ts" : "2020-04-23T08:00:00Z"
  } ]
}

Status code: 400

This status code is returned if the request fails.

{
  "error_code" : "400",
  "error_msg" : "Invalid request parameter: play_domains"
}

Status Codes

Status Code

Description

200

This status code is returned if the request succeeds.

400

This status code is returned if the request fails.

Error Codes

See Error Codes.

Parent topic: Statistical Analysis