Get Bestselling LIVE Sessions

GET

/analytics/202511/lives/bestselling

Get up to 100 LIVE sessions ranked by GMV for the period defined by date and time_slot.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

date

string format: date

The reference date, in ISO 8601 YYYY-MM-DD format and the shop’s registered timezone. The period ends on this date, inclusive, and extends backward according to time_slot (for example, 7D covers the seven days ending on this date). The date must be on or before the latest available data date. If a later date is submitted, the error response states the latest available data date; retry the request with that date or an earlier one.

time_slot

string

Allowed values: 1D 7D 30D

Specifies the query time range. Supported values are:

• 1D: query data for 1 day

• 7D: query data for 7 days

• 30D: query data for 30 days

This field determines the maximum range that can be queried using the date field.

currency

string

Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. If omitted, this parameter defaults to LOCAL.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

lives

List of bestselling LIVE session records for the target date range.

Array<object>

object

rank

GMV rank of the LIVE session

integer format: int64

gmv_range

GMV range of the LIVE session.

string

id

LIVE session id

string

title

LIVE session title

string

start_time

Start time of the LIVE session as a Unix timestamp in seconds (UTC+00:00).

integer format: int64

duration

LIVE session duration, in seconds.

integer format: int64

creator_name

The creator’s unique username used for system identification.

string

open_id

The creator’s unique ID, uniquely identifying the creator in the system.

string

creator_nick_name

The creator’s display nickname, visible externally.

string

Example

{
  "code": 0,
  "data": {
    "lives": [
      {
        "rank": 1,
        "gmv_range": "$97000.00~$191000.00",
        "id": "399123",
        "title": "Dude's deal",
        "start_time": 1623812664,
        "duration": 7602,
        "creator_name": "abc_bec",
        "open_id": "41YL0AAAAAD7kUt1BK3H07WBF3MZWzCgL79vJ-xBgswGeL2BCGdmeQ",
        "creator_nick_name": "ttnickname"
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}