v2.video.get_overview_performance
GET /api/v2/video/get_overview_performance
Get overall performance data for all post Shopee Video. There is at least a one-day delay.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/video/get_overview_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 |
|---|---|---|---|---|
| period_type | string | True | Month | Period Type. Applicable values: Day Week Month Last7d Last15d Last30d Note: The end date must align with the Period Type. |
| end_date | string | True | 2025-09-30 | The end_date format should be "YYYY-MM-DD". - For Day, Last7d, Last15d, and Last30d, the end_date must before current day. - For Week, the end_date must be Sunday and must be less than or equal to the current week. - For Month, the end_date must be the end of the month and must be less than or equal to the current month. |
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 | ||
| key_metric | object | ||
| placed_sales | float | 1.0 | The placed value of orders from all videos in the period selected. |
| confirmed_sales | float | 1.0 | The confirmed value of orders from all videos in the period selected. |
| placed_orders | int64 | 2 | The number of placed orders from all videos in the period selected. |
| confirmed_orders | int64 | 2 | The number of confirmed orders from all videos in the period selected. |
| placed_item_sold | int64 | 3 | Number of item sold from placed orders in the video. |
| confirmed_item_sold | int64 | 3 | Number of item sold from confirmed orders in the video. |
| total_viewers | int64 | 4 | Number of viewers of the video. |
| effective_views | int64 | 4 | Number of views for the video that lasted for more than 3 seconds. |
| avg_view_duration | int64 | 5 | Total watch duration per video. |
| conversion | object | ||
| placed_buyers | int64 | 2 | Number of unique buyers who placed order from the video. |
| confirmed_buyers | int64 | 2 | Number of unique buyers who confirmed order from the video. |
| total_atc | int64 | 2 | Number of "Add To Cart" button clicked for all products in the orange bag during video viewing. |
| ctr | float | 3.0 | Number of products clicks divided by Number of video views. |
| placed_co_rate | float | 1.0 | Number of placed product orders from the video divided by Number of product clicks from the video. |
| confirmed_co_rate | float | 1.0 | Number of confirmed product orders from the video divided by Number of product clicks from the video. |
| placed_abs | float | 1.0 | Total placed sales divided by Total placed orders. |
| confirmed_abs | float | 2.0 | Total confirmed sales divided by Total confirmed orders. |
| placed_gpm | float | 3.0 | The placed Sales generated for every 1,000 views. |
| confirmed_gpm | float | 4.0 | The confirmed Sales generated for every 1,000 views. |
| video_with_products | int64 | 2 | Videos with at least one product in the orange bag. |
| placed_revenue_generating_videos | int64 | 1 | Videos that generates placed revenues. |
| confirmed_revenue_generating_videos | int64 | 1 | Videos that generates confirmed revenues. |
| engagement | object | ||
| total_views | int64 | 1 | Number of views from all videos |
| total_likes | int64 | 1 | Number of likes from all videos |
| total_shares | int64 | 1 | Number of shares from all videos |
| total_comments | int64 | 1 | Number of comments from all videos |
| video_new_followers | int64 | 1 | Number of new followers from all videos |
| fetched_date_range | string | 2025-02-28 | Data offline computation time. |