v2.principal.get_session_livestream_performance

Queries livestream session performance data for the specified sessions within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and session-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_session_livestream_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"cursor\": 0,
   \"end_date\": \"2026-01-31\",
   \"granularity\": \"month\",
   \"page_size\": 100,
   \"session_list\": [
      {
         \"currency\": \"LOCAL\",
         \"session_ids\": [
            1453493,
            1453494
         ],
         \"shop_id\": 181050132
      }
   ],
   \"start_date\": \"2026-01-01\",
   \"timezone\": \"GMT+8\"
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/principal/get_session_livestream_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": 0,
    "end_date": "2026-01-31",
    "granularity": "month",
    "page_size": 100,
    "session_list": [
        {
            "currency": "LOCAL",
            "session_ids": [
                1453493,
                1453494
            ],
            "shop_id": 181050132
        }
    ],
    "start_date": "2026-01-01",
    "timezone": "GMT+8"
}',
  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_session_livestream_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": 0,
   "end_date": "2026-01-31",
   "granularity": "month",
   "page_size": 100,
   "session_list": [
      {
         "currency": "LOCAL",
         "session_ids": [
            1453493,
            1453494
         ],
         "shop_id": 181050132
      }
   ],
   "start_date": "2026-01-01",
   "timezone": "GMT+8"
}'

Python

import requests
import json

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

payload=json.dumps({
  "cursor": 0,
  "end_date": "2026-01-31",
  "granularity": "month",
  "page_size": 100,
  "session_list": [
    {
      "currency": "LOCAL",
      "session_ids": [
        1453493,
        1453494
      ],
      "shop_id": 181050132
    }
  ],
  "start_date": "2026-01-01",
  "timezone": "GMT+8"
})
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": "bb8d45e5-db10-4de4-8fb6-56d2fb316996",
	"error": "",
	"message": "",
	"response": {
		"summary": [
			{
				"currency": "USD",
				"likes": 11841,
				"comments": 2007,
				"buyers": 448,
				"orders": 508,
				"total_views": 201558,
				"unique_viewers": 141232,
				"total_live_duration": 1025729,
				"average_views_duration": 47.39170301348136,
				"new_followers": 468,
				"atc_units": 4402,
				"units_sold": 523,
				"sales_gross": 120130.36750199998,
				"sales_net": 90505.17313499999,
				"conversion_rate": 0.002520366346163387
			}
		],
		"details": [
			{
				"region": "SG",
				"currency": "LOCAL",
				"likes": 89,
				"comments": 3,
				"buyers": 2,
				"orders": 2,
				"shop_id": 181050132,
				"shop_name": "Huawei Official Store",
				"session_id": 1453493,
				"session_name": "HUAWEI Mid-Month Madness",
				"total_views": 575,
				"unique_viewers": 441,
				"total_live_duration": 7262,
				"average_views_duration": 44.3968253968254,
				"new_followers": 1,
				"atc_units": 14,
				"units_sold": 2,
				"sales_gross": 420,
				"sales_net": 420,
				"conversion_rate": 0.0034782608695652175
			}
		],
		"next_cursor": 100
	}
}

Error example

JSON

{
    "request_id": "c9f661d8-9fc4-45a8-a327-f3787f8523ab",
    "error": "error_param",
    "message": "page_size must be less than or equal to 200.",
    "response": null
}

Errors

Common errors

Update log