stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /customer_engagement/202412/performances
#§2 Method: [POST]
#§3 Function Description
Retrieve detailed performance metrics for a customer engagement task, including message reads, order conversions, and other key engagement statistics.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Shop_cipher is required for cross-border shops, and optional for local shops. It's unique for each shop. Get the this property from the Get Authorized Shop API dynamically. Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| task_ids | []string | Y | [8646958016719848812] | The list of tasks for which you want to retrieve performance data. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/customer_engagement/202412/performances?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"task_ids":[8646958016719848000]}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^task_performances | []object | The requested list of task performance. | |
| ^^id | string | 8646958016719848812 | The customer engagement task ID for this performance record. |
| ^^status | string | SENDING | The status of the task. |
| Possible values: |
SENDING: The task is sending messages.FAILED: The task failed to send messages.CANCELED: The task was canceled.SUCCESS: The task completed successfully. | ^^sent_recipient_count |int |100 |The number of users that received the message. | ^^read_recipient_count |int |20 |The number of users that read the message. | ^^order_count |int |10 |The number of orders resulting from the message. | ^^gmv_amount |string |5.5 |The revenue from the converted orders. | ^^claimed_coupons_count |int |1 |The number of coupons claimed. |
§9 Response Sample
{"code":0,"data":{"task_performances":[{"id":"8646958016719848812","status":"SENDING","sent_recipient_count":100,"read_recipient_count":20,"order_count":10,"gmv_amount":"5.5","claimed_coupons_count":1}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|