v2.principal.get_clip_video_performance

Queries video clip performance data for the specified videos within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and video-level detailed metrics.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"start_date": "2026-01-01",
	"end_date": "2026-01-31",
	"timezone": "GMT+8",
	"granularity": "month",
	"page_size": 100,
	"cursor": 0
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/principal/get_clip_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"cursor\": 100,
   \"end_date\": \"2026-01-31\",
   \"granularity\": \"month\",
   \"page_size\": 100,
   \"start_date\": \"2026-01-01\",
   \"timezone\": \"GMT+8\",
   \"video_list\": [
      {
         \"currency\": \"LOCAL\",
         \"shop_id\": 181050132,
         \"video_ids\": [
            1453493,
            1453494
         ]
      }
   ]
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/principal/get_clip_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "cursor": 100,
    "end_date": "2026-01-31",
    "granularity": "month",
    "page_size": 100,
    "start_date": "2026-01-01",
    "timezone": "GMT+8",
    "video_list": [
        {
            "currency": "LOCAL",
            "shop_id": 181050132,
            "video_ids": [
                1453493,
                1453494
            ]
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/principal/get_clip_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cursor": 100,
   "end_date": "2026-01-31",
   "granularity": "month",
   "page_size": 100,
   "start_date": "2026-01-01",
   "timezone": "GMT+8",
   "video_list": [
      {
         "currency": "LOCAL",
         "shop_id": 181050132,
         "video_ids": [
            1453493,
            1453494
         ]
      }
   ]
}'

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/principal/get_clip_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "cursor": 100,
  "end_date": "2026-01-31",
  "granularity": "month",
  "page_size": 100,
  "start_date": "2026-01-01",
  "timezone": "GMT+8",
  "video_list": [
    {
      "currency": "LOCAL",
      "shop_id": 181050132,
      "video_ids": [
        1453493,
        1453494
      ]
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"request_id": "0b9847f8-9091-44ea-9eb1-59f3ce3bdf83",
	"error": "",
	"message": "",
	"response": {
		"summary": [
			{
				"currency": "USD",
				"total_views": 575,
				"unique_viewers": 441,
				"video_duration": 2.5,
				"average_views_duration": 44.3968253968254,
				"likes": 89,
				"comments": 3,
				"share": 2,
				"total_unique_buyers": 2,
				"atc_units": 14,
				"units_sold": 2,
				"orders": 2,
				"sales": 420,
				"conversion_rate": 0.0034782608695652175
			}
		],
		"details": [
			{
				"region": "SG",
				"currency": "LOCAL",
				"shop_id": 181050132,
				"shop_name": "Huawei Official Store",
				"video_id": 1453493,
				"video_name": "HUAWEI Mid-Month Madness",
				"total_views": 575,
				"unique_viewers": 441,
				"video_duration": 2.5,
				"average_views_duration": 44.3968253968254,
				"likes": 89,
				"comments": 3,
				"share": 2,
				"total_unique_buyers": 2,
				"atc_units": 14,
				"units_sold": 2,
				"orders": 2,
				"sales": 420,
				"conversion_rate": 0.0034782608695652175
			}
		],
		"next_cursor": 100
	}
}

Error example

JSON

{
    "request_id": "eb51ff6d-5196-4db4-bade-322f3676004e",
    "error": "error_param",
    "message": "cursor must be greater than or equal to 0.",
    "response": null
}

Errors

Common errors

Update log