v2.video.get_video_detail_metric_trend
GET /api/v2/video/get_video_detail_metric_trend
Get detailed metric trend data for individual post Shopee Video. There is at least a one-day delay.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/video/get_video_detail_metric_trend
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| user_id | int | 1 | Shopee's unique identifier for a user. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| post_id | string | True | YwOo_gZqCACXbM0UAAAAAA== | A unique identifier for Shopee videos. |
| metric_name | string | True | Likes | The name of metric that require obtaining trend data. Applicable values: Views, Likes, Comments, Shares, FollowersGrowth, PlacedOrders, PlacedSales, UniqueBuyers, ConversionRate, SoldItems, SalesPerOrder, SalesPerBuyer |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | 2af852cd-7420-4714-b7cd-33317f6fe548 | The identifier for an API request for error tracking. |
| response | object | Detail informations you are querying. | |
| metric_trend | object | The type of metric_trend is a map. The key is date (in millisecond timestamp format), and the value is the number corresponding to metric. |