Queries abnormal user experience events.

app

Yes

String

App ID

room_id

No

String

Room ID

uid

No

String

User ID

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.

limit

No

Integer

Number of results. The default value is 10.

offset

No

Integer

Query offset. The default value is 0.

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).

X-Request-Id

String

Unique identifier of the request

total

Integer

Total number of exceptions

events

Array of AbnormalEvent objects

List of abnormal experience events

time

String

Sampling time. The date format complies with the ISO 8601 standard and the UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ.

uid

String

ID of the user with an exception

room_id

String

ID of the room with an exception

stage

String

Abnormal phase

• join_room: joining a room

• communication: The call is in progress.

location

String

Event occurrence location

• local: The event occurs on the local client.

• remote: The event occurs at the remote end.

peer_uid

String

If the exception occurs at the remote end, peerid is the remote user ID. If the exception occurs at the local end, peerid is an empty string.

abnormal_type

Integer

Exception type

• 1: It takes a long time to enter a room (longer than 5s).

• 2: video frame freezing

• 3: audio intermittence

abnormal_type_desc

String

The exception type description corresponds to the exception type and supports internationalization. The options are as follows:

• It takes a long time to enter a room (longer than 5s).

  Video freezing

  Audio freezing

abnormal_factor

Integer

Abnormal factors

When the exception type is 1, the value range of the exception factor is as follows:

• 1: The link fails to be established.

• 2: The room is not idle.

• 3: The server is abnormal.

• 4: The server returns 503.

• 5: Authentication failed.

• 6: Authentication reattempt

• 7: Clock synchronization fails.

• 8: The URL is incorrect.

• 9: An internal exception occurs on the terminal.

• 90000004: The response to the signaling sent by the SDK for joining a room times out.

• 90100009: The web system does not receive the configuration information delivered by the MSP.

• 90100008: The WebSocket link fails to be established.

• 10000001: exception information returned by the server

• 31000003: exception information returned by the server

• 32000030: exception information returned by the server

• 15: SDP setting exception in the browser.

When the exception type is 2 or 3, the options are as follows:

• 1: The system CPU usage is high.

• 2: The CPU usage of the app is high.

• 3: uplink audio network delay

• 4: uplink audio network jitter

• 5: uplink video network delay

• 6: uplink video network jitter

• 7: downlink audio network delay

• 8: downlink audio network jitter

• 9: downlink video network delay

• 10: downlink video network jitter

• 11: uplink audio packet loss

• 12: uplink video packet loss

• 13: downlink audio packet loss

• 14: downlink video packet loss

• 15: No sound is heard in the downlink audio.

• 16: others

• 17: The peer user is offline.

• 18: The peer user has no code stream.

• 19: no frame rate of the peer user

• 20: There is no downlink code stream on the local server.

• 21: no frame rate on the downlink of the local server

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:

• Link setup failure

• The room is not idle.

• Server exception

• The server returns 503.

  -Authentication failed

• Authentication reattempt

• Time synchronization failure.

• Incorrect URL.

• An internal error occurs on the terminal.

• The response to the signaling sent by the SDK for joining a room times out.

• The web system does not receive the configuration information delivered by the MSP.

• The WebSocket link fails to be established.

• Exception information returned by the server.

• Exception information returned by the server.

• Exception information returned by the server.

• An exception occurred when setting the SDP in the browser.

When the exception type is 2 or 3, the exception factor description corresponds to the exception factor. The options are as follows:

• Heavy system CPU usage

• Heavy app CPU usage

• Uplink audio latency

• Uplink audio jitter

• Uplink video latency

• Uplink video jitter

• Downlink audio latency

• Downlink audio jitter

• Downlink video latency

• Downlink video jitter

• Uplink audio packet loss

• Uplink video packet loss

• Downlink audio packet loss

• Downlink video packet loss

• No sound is heard in the downlink audio.

  Others

• The peer user is offline.

• The peer user has no code stream.

• No frame rate of the peer user

• There is no downlink code stream on the local server.

• Downlink No Frame Rate of Local Server

In other cases, the exception factor is described as follows: Others

X-Request-Id

String

Unique identifier of the request

error_code

String

Error code.

error_msg

String

Error message.

200

OK.

400

Query failed.