Returns up to 100 videos ranked by gross merchandise value (GMV) in descending order for the date range selected by date and time_slot.
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.
The reference date (ISO 8601 YYYY-MM-DD format) in the shop’s registered timezone. The query calculates data backwards from this date based on time_slot (for example, 7D returns data for the 7 days ending on this date). This date is inclusive and must be on or before the latest available data date.
The length of the query period ending on date. Supported values are:
-
1D: 1 day
-
7D: 7 days
-
30D: 30 days
Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. If omitted, the default is LOCAL.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
List of bestselling video records for the target date range.
object
Gmv rank of the video
Video id
Creator handle
Gmv range of the video
Accumulative number of video views since the video was published.
Accumulative number of video likes since the video was published.
Accumulative number of video comments since the video was published.
Accumulative number of video shares since the video was published.
List of product anchors associated with the video, including product IDs and product names. Excludes deactivated and sold-out products.
object
Product ID in the product anchor. Excludes deactivated and sold-out products.
Product name in the product anchor. Deactivated and sold-out products are excluded.
The time when the video was published, as a Unix timestamp in seconds (UTC).
Duration of the video, in seconds.
Example
{ "code": 0, "data": { "videos": [ { "rank": 1, "id": "10484583", "nick_name": "abc_bec", "gmv_range": "$97000.00~$191000.00", "views": 939829, "likes": 83894, "comments": 1934, "shares": 223, "product_infos": [ { "product_id": "1731736614984386107", "product_name": "labubu" } ], "publish_time": 1623812664, "duration": 7602 } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}