v2.account_health.get_shop_performance

GET /api/v2/account_health/get_shop_performance

The data metrics of shop performance.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/account_health/get_shop_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.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

No Request Parameters Set.

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		The identifier for an API request for error tracking.
response	object
overall_performance	object
rating	int32		Overall Performance: Poor = 1 ImprovementNeeded = 2 Good = 3 Excellent = 4
fulfillment_failed	int32		The number of metrics that did not meet target under Fulfillment Performance type.
listing_failed	int32		The number of metrics that did not meet target under Listing Performance type.
custom_service_failed	int32		The number of metrics that did not meet target under Customer Service Performance type.
metric_list	object[]
metric_type	int32		Type of metric: Fulfillment Performance = 1 Listing Performance = 2 Customer Service Performance = 3
metric_id	int64		ID of metric. If metric_id < 0, it means that this is not a real metric, but a group of metrics. Non-Responded Chats = -1 Late Shipment Rate (All Channels) = 1 Non-Fulfilment Rate (All Channels) = 3 Preparation Time = 4 Chat Response Rate = 11 Pre-order Listing % = 12 Days of Pre-order Listing Violation = 15 Response Time = 21 Shop Rating = 22 No. of Non-Responded Chats = 23 Fast Handover Rate = 25 On-time Pickup Failure Rate = 27 On-time Pickup Failure Rate Violation Value = 28 Average Response Time = 29 Cancellation Rate (All Channels) = 42 Return-refund Rate (All Channels) = 43 Severe Listing Violations = 52 Other Listing Violations = 53 Prohibited Listings = 54 Counterfeit/IP infringement = 55 Spam Listings = 56 Late Shipment Rate (NDD) = 85 Non-fulfilment Rate (NDD) = 88 Cancellation Rate (NDD) = 91 Return-refund Rate (NDD) = 92 Customer Satisfaction = 95 % SDD Listings = 96 % NDD Listings = 97 Fast Handover Rate - SLS = 2001 Fast Handover Rate - FBS = 2002 Fast Handover Rate - 3PF = 2003 Poor Quality Products = 2011 % HD Listings = 2030 % HD Free Shipping Enabled = 2031 Saturday Shipment = 2032 Preparation Time PS = 2033
parent_metric_id	int64		ID of parent metric.
metric_name	string		Default name of metric.
current_period	float		The performance of the metric at current period.
last_period	float		The performance of the metric at last period.
unit	int32		Unit of metric: Number = 1 Percentage = 2 Second = 3 Day = 4 Hour = 5
target	object
value	float		Value of target.
comparator	string		Comparator of target: <, <=, >, >=, =
exemption_end_date	string		(Only for whitelist TW sellers) The exemption_end_date value will not be empty if ALL conditions are met: - The shop is in the "POL Shop Whitelist" - Within the "Exemption Period" - The metric_id is 12 (Pre-order Listing %) or 15 (Days of Pre-order Listing Violation)