GET Get Video Performances
Get Video Performances Creator Required scope: creator.video.write This is a US-creator-only API for now. And it is for getting Tiktok E-commerce video metrics(incliding anchor_display_rate, ctr, orders, items_sold, gmv) to analysis. Version 202403
GET/analytics/202403/videos/performances
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The creator access_token value from Get Access Token, when user_type = 1. Follow this guide to get creator access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| video_ids Required | string | Collection of video IDs for retrieving the e-commerce metrics. Callers must ensure that all video IDs share the same author ID. Limit collection size 100. Use "," to separate array elements when send in the query. |
| start_time_ge Required | int | Start date for the metrics, set with a one-day delay from today due to latency in the data pipeline. The start_time parameter must be within the last 180 days from the current date. Only date value is processed, hour/mininute/second values will be ignored. For example, if the start_time value is: 1703507696 ("26-12-2023 04:34:56"), backend service will only consider the part "26-12-2023" when doing the query because by default, in offline data analytics, there is no hour/min/sec data level. |
| end_time_le Required | int | End date for the metrics, set with a one-day delay from today due to latency in the data pipeline. Only date value is processed, hour/mininute/second values will be ignored. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext