Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying the Playback Profile
Updated on 2024-09-27 GMT+08:00
View PDF

Querying the Playback Profile

Function

Queries the playback profile of a stream.

The maximum query time span is one day. You can query data over the past 31 days.

This API can be used to query only the number of online users of FLV and RTMP streams.

Constraints

Only the data of domain names added to the new Live console in regions excluding CN North-Beijing1 can be queried. This restriction applies only to the HUAWEI CLOUD Chinese Mainland website.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/stats/stream-portraits

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

play_domain

Yes

String

Streaming domain name.

stream

No

String

Stream name.

time

Yes

String

Date of which the data you want to query. The format must comply with the ISO 8601 standard and is YYYYMMDD, for example, 20200904. You can query data over the last 31 days (excluding the current day).

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.

It 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 a 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

stream_portraits

Array of StreamPortrait objects

Playback profile details.
Table 6 StreamPortrait

Parameter

Type

Description

time

String

Date of which the data you want to query. The format must comply with the ISO 8601 standard and is YYYYMMDD, for example, 20200904. Data of the playback profiles from 00:00 to 23:59 on this day will be collected.

flow

Long

Total traffic, in bytes.

play_duration

Long

Total playback duration, in seconds.

request_count

Long

Total number of requests.

user_count

Long

Total number of viewers calculated based on IP address.

peak_user_count

Long

Peak number of viewers, which is calculated based on session IDs for the FLV and RTMP protocols, or IP addresses for other protocols. The number of viewers is collected every minute, and the highest value in the statistical period is returned.

peak_bandwidth

Long

Peak bandwidth. The unit is bit/s. The bandwidth usage is collected every 5 minutes, and the highest value in the statistical period is returned.

push_duration

Long

Total live stream pushing duration, in seconds.

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 description

Example Requests

Queries the stream profile of a streaming domain name.

GET /v2/{project_id}/stats/stream-portraits?play_domain=livepull-test.huaweicloud.com&stream=stream-000&time=20200904

Example Responses

Status code: 200

Query succeeded.

{
  "stream_portraits" : [ {
    "time" : 20200812,
    "flow" : 10,
    "play_duration" : 10,
    "request_count" : 10,
    "user_count" : 10,
    "peak_user_count" : 10,
    "peak_bandwidth" : 10,
    "push_duration" : 10
  } ]
}

Status code: 400

Incorrect parameter.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: play_domain"
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Statistics Analysis