Help Center/ SparkRTC/ API Reference/ Statistical Analysis/ Queries the distribution of users with abnormal events.
Updated on 2022-10-08 GMT+08:00

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

Table 1 Query Parameters

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.

  • abnormal_type: exception type

  • abnormal_factor: abnormal factor

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

Table 2 Request header 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

Table 3 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request

Table 4 Response body parameters

Parameter

Type

Description

dimensions

Array of AbnormalEventDimensionValue objects

List of abnormal experience events

Table 5 AbnormalEventDimensionValue

Parameter

Type

Description

abnormal_type

Integer

Type of an exception:

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

  • 2: video freezing

  • 3: audio freezing

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 delay

  • 4: uplink audio jitter

  • 5: uplink video delay

  • 6: uplink video jitter

  • 7: downlink audio delay

  • 8: downlink audio jitter

  • 9: downlink video delay

  • 10: downlink video 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 Others.

user_count

Long

Number of users affected by an exception

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request

Table 7 Response body parameters

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.