On this page

Show all

Help Center/ SparkRTC/ API Reference/ Statistical Analysis/ Querying Real-Time Scale Data

Querying Real-Time Scale Data

Updated on 2025-02-08 GMT+08:00

View PDF

Function

Queries the statistics on scale-related indicators of every minute in a specified period.

The maximum query time span is one day.

URI

GET /v1/{project_id}/rtc/realtime/scale

**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	Yes	String	Application identifier.
room_id	No	String	Room ID.
metric	Yes	String	Data type: OnlineUsers: number of online users RoomCount: number of rooms in use
start_time	No	String	Time when the query starts. UTC time in the format of YYYY-MM-DDThh:mm:ssZ, for example, 2020-04-23T06:00:00Z. If this parameter is not specified, data of the last hour is read by default.
end_time	No	String	Time when the query ends. 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 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
scale	Array of TimeValueData objects	Timestamp and indicator list at the corresponding time.

**Table 6** TimeValueData
Parameter	Type	Description
time	String	Sampling time. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ.
value	Long	Traffic indicators.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET /v1/{project_id}/rtc/realtime/scale?app=5fa682b34a974f7ad24d223b

Example Responses

Status code: 200

This status code is returned if the request succeeds.

{
  "scale" : [ {
    "time" : "2020-06-04T07:00:00Z",
    "value" : 0
  } ]
}

Status code: 400

This status code is returned if the request fails.

{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app' is not present"
}

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

Previous topic: Listing Users

Next topic: Querying Real-Time Scale Data Distribution

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot