Returns a list of videos and associated metrics for a shop.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”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.
Number of videos per page. Minimum value: 1 Maximum value: 100 Default value: 10
Field used to sort the shop video performance list. Default value: gmv Available values:
- gmv: sort by overall Gross Merchandise Value (GMV).
- gpm: sort by average GMV generated from 1,000 views.
- avg_customers: sort by daily average customers.
- sku_orders: sort by paid SKU orders.
- items_sold: sort by units sold.
- views: sort by video views.
- click_through_rate: sort by the ratio of product clicks to video views.
- post_time: sort by the time the video was posted.
Sort direction. Available values: ASC, DESC Default value: DESC
- ASC: ascending
- DESC: descending
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
Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries.
Types of the accounts under which videos were created. Available values: ALL, OFFICIAL_ACCOUNTS, MARKETING_ACCOUNTS, AFFILIATE_ACCOUNTS Default value: ALL
- ALL: all account types
- OFFICIAL_ACCOUNTS: official accounts
- MARKETING_ACCOUNTS: marketing accounts
- AFFILIATE_ACCOUNTS: affiliate accounts
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Latest date in local timezone where data is ready (ISO 8601 format).
Page token for the next page request. Pass a nonempty returned token as page_token in the next request and reuse the same start_date_ge, end_date_lt, sort_field, sort_order, currency, account_type, and page_size values. An empty value means there are no more pages.
Total number of videos matching the request filters across all pages.
List of video performance metrics.
object
Whether the video can be used for advertising.
Total GMV attributed to the video.
object
Attributed GMV amount.
Attributed GMV currency code.
Daily average customers.
Ratio of product clicks to video views in raw decimal format.
Number of comments received by the video.
Creator information for the video.
object
Creator account type.
Country or region of the creator.
The creator ID.
Creator nickname.
The creator open ID.
Creator username (handle).
Click-to-order rate in raw decimal format.
Video duration in seconds.
GMV directly attributed to the video.
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 from 1,000 video views.
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).
Hash tags of the video.
The unique identifier of the video in the performance list.
Indirect GMV attributed to the video.
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).
Number of units sold from the video.
Number of likes received by the video.
Number of new followers attributed to the video.
Number of product clicks from the video.
Number of product impressions from the video.
Products promoted in the video.
object
The unique identifier of the product.
The product name.
Review classification of the video.
Number of times the video was shared.
The total number of paid SKU orders placed directly from the current video.
The title of the video.
The username associated with the video.
Number of clicks from the video to a LIVE session.
Rate of clicks from the video to a LIVE session in raw decimal format.
Video completion rate in raw decimal format.
Date and time when the video was posted.
Number of video views during the selected time range.
Example
{ "code": 0, "data": { "latest_available_date": "2024-09-07", "next_page_token": "cGFnZV9udW1iZXI9MQ==", "total_count": 10, "videos": [ { "advertisable": true, "attributed_gmv": { "amount": "125.50", "currency": "USD" }, "avg_customers": 35, "click_through_rate": "0.0525", "comments": 12, "creator": { "author_type": "OFFICIAL", "creator_country": "US", "creator_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "nick_name": "abc_bec", "open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "user_name": "creator_shop_01" }, "ctor": "0.0528", "duration": 34, "gmv": { "amount": "125.50", "currency": "USD" }, "gpm": { "amount": "32.40", "currency": "USD" }, "hash_tags": [ "#racuntiktok", "fyp" ], "id": "172xxxxxxxxxxxxx089", "indirect_gmv": { "amount": "125.50", "currency": "USD" }, "items_sold": 18, "likes": 86, "new_followers": 10, "product_clicks": 63, "product_impressions": 1200, "products": [ { "id": "105xxxxxxxxxxxxx247", "name": "Wireless Earbuds" } ], "review_type": "IMPROVEMENT", "shares": 8, "sku_orders": 12, "title": "How to Style Summer Outfits", "username": "creator_shop_01", "v_to_l_clicks": 42, "v_to_l_rate": "0.0350", "video_finish_rate": "0.3800", "video_post_time": "2025-01-01 00:00:00", "views": 1200 } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}