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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain |
Yes |
String |
Queries a domain name. Currently, only one or all domain names can be queried. Possible values are:
|
date |
Yes |
String |
Query date. The format is yyyymmdd.
|
Request 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
Parameter |
Type |
Description |
---|---|---|
top_urls |
Array of TopUrl objects |
Specifies the 100 most requested URLs of a domain name. |
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 |
size |
Long |
Size of the original media file Unit: byte |
Status code: 400
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, "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot