Returns detailed performance metrics for a (requested) video.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The ID of the shop video whose performance details are requested.
Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
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)
The time range between start and end must not exceed 60 days.
End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. In the parameter name, “lt” refers to “less than” (exclusive)
The time range between start and end must not exceed 60 days.
Granularity of the data. Available values: ALL, 1D Default value: ALL
- ALL: aggregate
- 1D: daily
Currently, only local currency is supported in the response.
Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Overall performance data for the video.
object
Interval data for the requested time range. The time range of each interval is determined by the granularity.
object
Start date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive.
End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive.
Sale performance data.
object
Overall performance
object
The total amount paid for orders placed directly from the shoppable video, including returns and refunds.
object
GMV amount in the corresponding currency.
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).
The avg. video GPM is the average GMV generated from 1,000 impressions of the Video.
object
GPM amount in the corresponding currency.
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).
The total number of customers who placed orders directly from the shoppable video.
The total number of items sold directly from the shoppable video.
Ratio of product clicks from the video to impressions of all products in the video, expressed as a decimal fraction.
The number of impressions of all video products
The number of product clicks from the video
Breakdown data for product-level sales performance in each interval.
object
Id of the product linked to this video
Gross merchandise value (GMV) for this product in the interval.
object
GMV amount in the corresponding currency.
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).
Average GMV generated for this product per 1,000 video impressions in the interval.
object
GPM amount in the corresponding currency.
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).
The total number of customers who placed orders directly from the shoppable video.
The total number of items sold directly from the shoppable video.
The number of product clicks from the video / The number of impressions of all video products
The number of impressions of all video products
The number of product clicks from the video
Traffic performance of the video.
object
Number of times the requested video was watched during the interval. Repeat views by the same user are counted separately.
The number of times a user followed you after watching a video
The cumulative number of times users shared the video
The cumulative number of times users left comments on the video
The cumulative number of times users liked the video
Viewer profile of the video
object
Viewer profile type. Possible values:
-
NEW_FOLLOWER: viewers who newly followed after watching the video
-
VIEWERS: viewers of the video
View gender distribution
object
Viewer gender. Possible values:
-
MALE: male viewers
-
FEMALE: female viewers
Proportion for the corresponding gender within this viewer profile, expressed as a decimal fraction.
Viewer age distribution
object
Possible values:
- 18-24
- 25-34
- 35-44
- 45-54
- 55+
Proportion for the corresponding age group within this viewer profile, expressed as a decimal fraction.
Viewer country distribution.
object
The region of the viewer’s TikTok account.
Proportion for the corresponding country within this viewer profile, expressed as a decimal fraction.
Latest date in local timezone where data is ready (ISO 8601 format).
Example
{ "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"}