stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_videos/{video_id}/performance
#§2 Method: [GET]
#§3 Function Description
Returns detailed performance metrics for a (requested) video.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| video_id | string | Y | 7523456789012345678 | The ID of the shop video whose performance details are requested. |
§6 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. |
| start_date_ge | string | Y | 2024-09-01 | Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "ge" refers to "greater than or equal to" (inclusive) | ||||
| end_date_lt | string | Y | 2024-09-08 | End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "lt" refers to "less than" (exclusive) | ||||
| granularity | string | N | ALL | Granularity of the data. |
| Available values: ALL, 1D | ||||
| Default value: ALL |
- ALL: aggregate
- 1D: daily | currency |string |N |USD |Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_videos/7523456789012345678/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-09-01&end_date_lt=2024-09-08&granularity=ALL¤cy=USD
§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 | |
| ^performance | object | Overall performance data for the video. | |
| ^^intervals | []object | Interval data for the requested time range. The time range of each interval is determined by the granularity. | |
| ^^^start_date | string | 2024-09-01 | Start date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| ^^^end_date | string | 2024-09-08 | End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| ^^^sales | object | Sale performance data. | |
| ^^^^overall | object | Overall performance | |
| ^^^^^gmv | object | The total amount paid for orders placed directly from the shoppable video, including returns and refunds. | |
| ^^^^^^amount | string | 230.02 | GMV amount in the corresponding currency. |
| ^^^^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^^^^gpm | object | The avg. video GPM is the average GMV generated from 1,000 impressions of the Video. | |
| ^^^^^^amount | string | 1.02 | GPM amount in the corresponding currency. |
| ^^^^^^currency | string | USD | GPM currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^^^^customers | int | 12 | The total number of customers who placed orders directly from the shoppable video. |
| ^^^^^items_sold | int | 22 | The total number of items sold directly from the shoppable video. |
| ^^^^^ctr | string | 0.029 | The number of product clicks from the video / The number of impressions of all video products |
| ^^^^^product_impressions | int | 32092 | The number of impressions of all video products |
| ^^^^^product_clicks | int | 21232 | The number of product clicks from the video |
| ^^^^breakdowns | []object | Breakdown data for product-level sales performance in each interval. | |
| ^^^^^product_id | string | 19332235 | Id of the product linked to this video |
| ^^^^^gmv | object | gmv data | |
| ^^^^^^amount | string | 230.02 | GMV amount in the corresponding currency. |
| ^^^^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^^^^gpm | object | gpm data | |
| ^^^^^^amount | string | 1.02 | GPM amount in the corresponding currency. |
| ^^^^^^currency | string | USD | GPM currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^^^^customers | int | 12 | The total number of customers who placed orders directly from the shoppable video. |
| ^^^^^items_sold | int | 22 | The total number of items sold directly from the shoppable video. |
| ^^^^^ctr | string | 0.029 | The number of product clicks from the video / The number of impressions of all video products |
| ^^^^^product_impressions | int | 32092 | The number of impressions of all video products |
| ^^^^^product_clicks | int | 21232 | The number of product clicks from the video |
| ^^^traffic | object | Traffic performance of the video. | |
| ^^^^views | int | 76649 | The number of times your videos have been watched (if the same user watches a video multiple times, each time is counted) |
| ^^^^new_followers | int | 11 | The number of times a user followed you after watching a video |
| ^^^^shares | int | 23 | The cumulative number of times users shared the video |
| ^^^^comments | int | 8 | The cumulative number of times users left comments on the video |
| ^^^^likes | int | 2 | The cumulative number of times users liked the video |
| ^^viewer_profile | []object | Viewer profile of the video | |
| ^^^type | string | VIEWERS | Viewer profile type. Possible values: |
- NEW_FOLLOWER: viewers who newly followed after watching the video
- VIEWERS: viewers of the video | ^^^gender_distribution |[]object | |View gender distribution | ^^^^gender |string |MALE |Viewer gender. Possible values:
- MALE: male viewers
- FEMALE: female viewers | ^^^^percentage |string |0.349 |Percentage of the corresponding gender. | ^^^age_distribution |[]object | |Viewer age distribution | ^^^^age |string |25-34 |Possible values:
- 18-24
- 25-34
- 35-44
- 45-54
- 55+ | ^^^^percentage |string |0.293 |Percentage of the corresponding age. | ^^^country_distribution |[]object | |Viewer country distribution. | ^^^^country_code |string |MY |The region of the viewer's TikTok account. | ^^^^percentage |string |0.993 |Percentage of the corresponding country. | ^latest_available_date |string |2024-09-07 |Latest date in local timezone where data is ready (ISO 8601 format). |
§9 Response Sample
{"code":0,"data":{"performance":{"intervals":[{"start_date":"2024-09-01","end_date":"2024-09-08","sales":{"overall":{"gmv":{"amount":"230.02","currency":"USD"},"gpm":{"amount":"1.02","currency":"USD"},"customers":12,"items_sold":22,"ctr":"0.029","product_impressions":32092,"product_clicks":21232},"breakdowns":[{"product_id":"19332235","gmv":{"amount":"230.02","currency":"USD"},"gpm":{"amount":"1.02","currency":"USD"},"customers":12,"items_sold":22,"ctr":"0.029","product_impressions":32092,"product_clicks":21232}]},"traffic":{"views":76649,"new_followers":11,"shares":23,"comments":8,"likes":2}}],"viewer_profile":[{"type":"VIEWERS","gender_distribution":[{"gender":"MALE","percentage":"0.349"}],"age_distribution":[{"age":"25-34","percentage":"0.293"}],"country_distribution":[{"country_code":"MY","percentage":"0.993"}]}]},"latest_available_date":"2024-09-07"},"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 |
|---|---|
| 28001022 | invalid request params; detail: start time or end time is invalid. |