v2.video.get_video_performance_list
GET /api/v2/video/get_video_performance_list
Get specific dữ liệu hiệu suất for individual post Shopee Video. There is at least a one-day delay.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/video/get_video_performance_list
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| user_id | int | 1 | Shopee's mã định danh duy nhất 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. |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| page_no | int32 | True | 1 | The start index of request. Starting from 1. |
| page_size | int32 | True | 10 | The number of video returned by this request. Max is 20. |
| period_type | string | True | Last7d | Period Type. Các giá trị áp dụng: Day Week Month Last7d Last15d Last30d Note: The end date must align with the Period Type. |
| end_date | string | True | 2025-10-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. |
| caption | string | False | Mô tả về the Shopee Video. | |
| order_by | string | True | Likes | Use this field to specify which field to use to sort the returned list. Available values: Views Likes Comments AvgViewsThời lượng |
| sort | string | True | desc | Use this field to specify whether the returned list is sorted in ascending or descending order_by. Available values: asc desc |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| message | string | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| request_id | string | 2af852cd-7420-4714-b7cd-33317f6fe548 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| response | object | Detail informations you are querying. | |
| total_count | int32 | 1 | Tổng số video that match the tình trạng. |
| has_more | boolean | false | This is to indicate whether the danh sách video is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of data. |
| list | object[] | The danh sách video that match the tình trạng. | |
| video_upload_id | string | id-11110201-6ko2m-mczrffx878mba3 | ID of uploaded video. |
| post_id | string | YwOo_gZqCACXbM0UAAAAAA== | The mã định danh duy nhất for post Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| post_time | timestamp | 1761188662147 | The time when the video post to Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| video_url | string | https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4 | Video play url. |
| status | int64 | 300 | Video current status. Các giá trị áp dụng: 300: POSTED 400: DELETED |
| cover_image_url | string | https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg | Ảnh bìa url of the Shopee Video. |
| caption | string | #tt Tt1 | Mô tả về the Shopee Video. |
| duration | string | 6866 | Video thời lượng time in millisecond. |
| views | int64 | 1 | Số lượt xem of post Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| likes | int64 | 1 | Số lượt thích the post Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| comments | int64 | 1 | Số lượt bình luận the post Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| shares | int64 | 1 | Số lượt chia sẻ the post Shopee Video. Only have value when the trạng thái video is 300 (POSTED). |
| avg_views_duration | int64 | 1 | Total watch thời lượng per video. |
| completion_rate | float | 1.0 | Video completion rate. |
| placed_orders | int64 | 1 | The number of placed orders for the video. |
| confirmed_orders | int64 | 1 | The number of confirmed orders for the video. |
| placed_sales | float | 1.2 | The placed value of orders for the video. |
| confirmed_sales | float | 1.0 | The confirmed value of orders for the video. |
| placed_item_sold | int64 | 1 | Number of item sold from placed orders in the video. |
| confirmed_item_sold | int64 | 1 | Number of item sold from confirmed orders in the video. |
| fetched_date_range | string | 2025-10-30 | Data Date Range. |
Unirest.setTimeouts(0, 0); HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/video/get\_video\_performance\_list?access\_token=access\_token&caption=-&end\_date=2025-10-30&order\_by=Likes&page\_no=1&page\_size=10&partner\_id=partner\_id&period\_type=Last7d&sign=sign&sort=desc×tamp=timestamp&user\_id=user\_id") .asString();<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/video/get\_video\_performance\_list?access\_token=access\_token&caption=-&end\_date=2025-10-30&order\_by=Likes&page\_no=1&page\_size=10&partner\_id=partner\_id&period\_type=Last7d&sign=sign&sort=desc×tamp=timestamp&user\_id=user\_id', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; curl --location --request GET 'https://partner.shopeemobile.com/api/v2/video/get\_video\_performance\_list?access\_token=access\_token&caption=-&end\_date=2025-10-30&order\_by=Likes&page\_no=1&page\_size=10&partner\_id=partner\_id&period\_type=Last7d&sign=sign&sort=desc×tamp=timestamp&user\_id=user\_id' import requests url = "https://partner.shopeemobile.com/api/v2/video/get\_video\_performance\_list?access\_token=access\_token&caption=-&end\_date=2025-10-30&order\_by=Likes&page\_no=1&page\_size=10&partner\_id=partner\_id&period\_type=Last7d&sign=sign&sort=desc×tamp=timestamp&user\_id=user\_id" payload={} headers = { } response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False) print(response.text)
] } }