v2.video.get_video_detail_performance
GET /api/v2/video/get_video_detail_performance
Get detailed performance 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_performance
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. |
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. | |
| video_info | object | Video post detail informations you are querying. | |
| post_id | string | YwOo_gZqCACXbM0UAAAAAA== | A unique identifier for Shopee videos. |
| post_time | timestamp | 1761188662147 | The time when the video post to Shopee Video. |
| video_url | string | https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4 | Video play url. |
| cover_image_url | string | https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg | Cover image url of the Shopee Video. |
| caption | string | #tt Tt1 | Description of the Shopee Video. |
| duration | int64 | 6866 | Video duration time in millisecond. |
| related_item_count | int64 | 1 | Number of products linked with the Shopee Video. |
| video_performance | object | Overall performance data of the video you are querying. | |
| views | int64 | 1 | Amount of views from the video. |
| likes | int64 | 1 | Total likes from the video. |
| comments | int64 | 1 | Total comments from the video. |
| shares | int64 | 1 | Total shares from the video. |
| followers_growth | int64 | 1 | Amount of new followers from the Video. |
| placed_orders | int64 | 1 | Amount of product orders from the video. |
| placed_sales | float | 1.0 | Amount of product sales from the video. |
| unique_buyers | int64 | 1 | Buyers of the products in the video. |
| conversion_rate | float | 1.0 | Amount of products sold from the video/amount of views from the video. |
| sold_items | int64 | 1 | Amount of products sold from the video. |
| product_clicks | int64 | 1 | The product click value of orders for item. |
| product_click_rate | float | 2.0 | The product click rate value of orders for item. |
| sales_per_order | float | 1.0 | Amount of product sales from the video/amount of product orders from the video. |
| sales_per_buyer | float | 1.0 | Amount of product sales from the video/amount of buyers from the video. |