Help Center/ Video On Demand/ API Reference/ Statistical analysis/ Queries statistics on the top N media assets
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries statistics on the top N media assets

Function

Queries statistics on the top 100 media assets by playback time for a specified domain name on a specified date

URI

GET /v1.0/{project_id}/asset/top-statistics

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

domain

Yes

String

Queries a domain name. Currently, only one or all domain names can be queried.

Possible values are:

  • Single acceleration domain name. The format is as follows: example.test1.com.

  • ALL indicates that all domain names under a tenant are queried.

date

Yes

String

Query date. The format is yyyymmdd.

  • The value of date must be the previous day or earlier.

  • You can query data of the past month.

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 for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

top_urls

Array of TopUrl objects

Specifies the 100 most requested URLs of a domain name.
Table 5 TopUrl

Parameter

Type

Description

value

Long

Total playback times

asset_id

String

Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.

title

String

Media asset name

duration

Integer

Media file duration

Unit: second

duration_ms

Long

Video duration, in milliseconds.

size

Long

Size of the original media file

Unit: byte

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries the top 100 most queried media files.

GET https://{endpoint}/v1.0/{project_id}/asset/top-statistics?domain=ALL&date=20190612

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "top_urls" : [ {
    "value" : 0,
    "asset_id" : "548b6023bf2cc925bd64343f04ca0f88",
    "title" : "test",
    "duration" : 0,
    "duration_ms" : 0,
    "size" : 0
  } ]
}

Status code: 400

The information is returned when the request fails.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Statistical analysis