v2.livestream.get_session_metric

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:12:37

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.livestream.get_session_metric

Get real-time indicator data of the live stream room, including the number of likes, comments, shares, views, etc.(For TW, ID, TH, PH, MY, SG, VN)

§2 Overview

Overview

Field	Value
Module	Livestream
API type	User
HTTP method	GET
Path	/api/v2/livestream/get_session_metric
Production URL	https://partner.shopeemobile.com/api/v2/livestream/get_session_metric
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/livestream/get_session_metric
Permission	Livestream Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
session_id	int64	Yes	6236215	The identifier of livestream session.

§4 Response parameters

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	e3e3e7f3360690a5b55f0689f8a4e801	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
response.gmv	float	1.0	Value of placed orders (paid and unpaid) during Livestream, including sales from cancelled orders.
response.atc	int64	1	Number of "Add To Cart" button clicked for all products in the orange bag during livestream.
response.ctr	float	0.1	Number of products clicks divided by Number of Livestream views.
response.co	float	0.1	Amount of product orders from the stream divided by Amount of product clicks from the stream.
response.orders	int64	1	Number of placed orders (paid and unpaid) during Livestream, including cancelled orders.
response.ccu	int64	1	Number of viewers during stream.
response.engage_ccu_1m	int64	1	Number of Concurrent viewers in the stream that have watched for more than 1 minute.
response.peak_ccu	int64	1	Highest number of viewers during stream.
response.likes	int64	1	Number of "Like" clicked during livestream.
response.comments	int64	1	Number of comments acquired during the stream.
response.shares	int64	1	Number of shares created during the stream.
response.views	int64	1	Number of views from the stream.
response.avg_viewing_duration	int64	1	Average of Viewer duration watching in the stream.

§5 Common parameters

Common 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.

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/livestream/get_session_metric?access_token=access_token&partner_id=partner_id&session_id=6236215&sign=sign&timestamp=timestamp&user_id=user_id")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/livestream/get_session_metric?access_token=access_token&partner_id=partner_id&session_id=6236215&sign=sign&timestamp=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;

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/livestream/get_session_metric?access_token=access_token&partner_id=partner_id&session_id=6236215&sign=sign&timestamp=timestamp&user_id=user_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/livestream/get_session_metric?access_token=access_token&partner_id=partner_id&session_id=6236215&sign=sign&timestamp=timestamp&user_id=user_id"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"request_id": "e3e3e7f3360690a5b55f0689f8a4e801",
	"response": {
		"gmv": 1,
		"atc": 1,
		"ctr": 0.1,
		"co": 0.1,
		"orders": 1,
		"ccu": 1,
		"engage_ccu_1m": 1,
		"peak_ccu": 1,
		"likes": 1,
		"comments": 1,
		"shares": 1,
		"views": 1,
		"avg_viewing_duration": 1
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "error_data",
    "message": "The session(session_id:6236215) is not belong to you",
    "request_id": "2b02779a357abd74e15f4273b61a0f01",
    "response": {}
}

§15 Errors

Errors

Error	Description	Solution
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	Invalid session_id
error_auth	You are not authorized
error_data	The session(session_id:{{sid}}) is not belong to you
error_server	The API is not supported for current region
error_param	Parse data error: {{err_msg}}
error_server	Too many requests, please try again later
error_server	Server internal error: {{err_msg}}
error_data	The session(session_id:{{sid}}) is not exist
error_data	The session(session_id:{{sid}}) is not ongoing
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
user_no_linked	Partner and user has no linked.
user_banned	This user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
error_param	There is no user_id in query.
error_param	user_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2026-01-13	Update API Description
2025-06-24	New API

这条内容对你有帮助吗？