Returns up to 100 creators, filtered by author_type, ranked by GMV in the selected currency for the reporting period ending on date and defined by 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 inclusive end date of the reporting period, in ISO 8601 YYYY-MM-DD format and the shop’s registered timezone. The period extends backward from this date according to time_slot (for example, 7D covers the seven days ending on this date). The date must not be later than the latest available date; when a later date is submitted, the error message identifies the latest available date.
The length of the query period ending on date. Supported values are:
- 1D — 1 day
- 7D — 7 days
- 30D — 30 days
The creator type to include. Supported values are:
- ALL — include all creator types
- OFFICIAL — include official creators
- CHANNEL — include channel creators
- AFFILIATE — include affiliate creators
Currency for monetary values. Supported values are:
- USD — US dollars
- LOCAL — the local currency where the shop is registered If omitted, defaults to LOCAL.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
List of bestselling creator records for the target date range.
object
GMV rank of the creator.
The creator’s GMV range for the selected reporting period, expressed in the currency selected by currency.
Creator’s open id, use this open id to identify a creator.
The creator’s account handle.
The creator’s display name.
Number of followers
Number of likes
Example
{ "code": 0, "data": { "creators": [ { "rank": 1, "gmv_range": "$97000.00~$191000.00", "open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "user_name": "creator_example_01", "nick_name": "abc_bec", "followers_count": 11234, "likes_count": 23342 } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}