Help Center/ Video On Demand/ API Reference/ Statistical Analysis/ Querying Top-N Media Asset Statistics
Updated on 2026-01-16 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Top-N Media Asset Statistics

Function

This API is used to query statistics on the top 100 media assets by playback time for a specified domain name on a specified date

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

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

Domain name to be queried. You may specify a single domain name or all domain names.

The options include:

  • Single domain name, for example, example.test1.com.

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

date

Yes

String

Query date. The format is yyyymmdd.

  • The date must be the previous day or earlier.

  • You can only query data from the past month at most.

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 the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a 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

Top 100 most frequently 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. It can only be queried but cannot be modified.

title

String

Media asset name.

duration

Integer

Media file duration.

Unit: seconds

duration_ms

Long

Video duration, in milliseconds.

size

Long

Size of the original media file.

Unit: bytes

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example queries the statistics for the top 100 most frequently accessed media assets.

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

Example Responses

Status code: 200

Returned when the request succeeded.

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

Status code: 400

Returned when the request failed.

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

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Statistical Analysis