# Live rank list

live rank list data

Endpoint: GET /live/ranklist
Version: 1.0.0
Security: MuseumPlaceholderAuth

## Query parameters:

  - `date` (string, required)
    yyyy-MM-dd
    Example: "2024-12-15"

  - `region` (string, required)
    region code
    Example: "US/ID/TH/PH/MY/VN/GB/MX/SG/SA/BR/ES"

  - `product_category_id` (string)
    category id

  - `rank_type` (integer, required)
    rank cycle,1=day 2=week 3=month

  - `live_rank_field` (integer, required)
    rank field. 1=total_joins_cnt 2=total_sale_cnt

  - `page_num` (integer, required)
    page number

  - `page_size` (integer, required)
    page size

## Response 200 fields (application/json):

  - `room_id` (string)
    Example: "7225975530858810139"

  - `user_id` (string)
    Example: "6816163894920791042"

  - `unique_id` (string)
    Example: "pinkflash.beauty"

  - `nick_name` (string)
    Example: "PinkFlash Indonesia"

  - `region` (string)
    Example: "ID"

  - `title` (string)
    Example: "Saatnya Ramadan Sale di TikTok Shop!"

  - `cover_url` (string)
    Example: "https://echosell-images.tos-ap-southeast-1.volces.com/live-cover/504/7226218610434706182.webp"

  - `create_time` (string)
    Example: "1682485439"

  - `finish_time` (string)
    Example: "1682493310"

  - `duration` (string)
    Example: "7871"

  - `total_joins_cnt` (integer)
    Example: 1

  - `total_comments_cnt` (integer)
    Example: 1

  - `total_digg_cnt` (integer)
    Example: 1

  - `total_followers_cnt` (integer)
    Example: 1

  - `total_sale_cnt` (integer)
    Example: 1

  - `total_sale_gmv_amt` (number)
    Example: 12.34

  - `total_product_cnt` (integer)
    Example: 1

  - `new_user_ratio` (number)

  - `follow_user_ratio` (number)

  - `product_category_list` (array)
    Example: [{"category_name":"Perawatan & Kecantikan","category_id":"601450"}]

  - `total_shares_cnt` (integer)
    Example: 1

  - `total_views_cnt` (integer)
    Example: 100

## Response 403 fields (application/problem+json):

  - `code` (integer)
    Example: 403

  - `message` (string)
    Example: "Usage Limit Exceeded, Please Contact Administrator to Increase Quota"

## Response 429 fields (application/problem+json):

  - `code` (integer)
    Example: 429

  - `message` (string)
    Example: "speed limit"

## Response 500 fields (application/problem+json):

  - `code` (integer)
    Example: 500

  - `message` (string)
    Example: "inner error"

## Response 504 fields (application/problem+json):

  - `code` (integer)
    Example: 504

  - `message` (string)
    Example: "timeout"