REreacherapp
Lives

Per-session LIVE GMV rows

Changed on

Paginated per-session LIVE view for one shop — one row per LIVE session with host handle, is_own_account, timestamps, GMV, units, and engagement: views, unique viewers, average viewing duration (watch time, seconds), product_impressions, product_clicks, CTR, likes, comments and new followers. TikTok does not report viewers or product clicks for every session; those fields are null when unavailable.

account_type (default all) picks the sessions: creator = affiliate creators' LIVEs (live_gmv = Affiliate Center creator LIVE-attributed GMV), own = the shop's own brand-account LIVEs (live_gmv = official LIVE GMV), all = both.

Single-shop only. Defaults to the last 30 days ending today. Sort by live_gmv (default), start_time, units_sold or views. Empty sessions is a normal 200 response for shops without live-session data.

post/lives/list

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/lives/list
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Request body

account_type'all' | 'creator' | 'own'

Which LIVE sessions to include: creator = affiliate creators' LIVEs (Affiliate Center creator LIVE-attributed GMV), own = the shop's own brand-account LIVEs (official LIVE GMV), all = both. Defaults to all.

start_datestring date nullable

Inclusive window start (YYYY-MM-DD). Defaults to 29 days before end_date.

end_datestring date nullable

Inclusive window end (YYYY-MM-DD). Defaults to today.

pageinteger
page_sizeinteger
sort_by'live_gmv' | 'start_time' | 'units_sold' | 'views'
sort_dir'asc' | 'desc'

Response

Successful Response

shop_idinteger required
account_type'all' | 'creator' | 'own'

Session scope of sessions.

currencystring nullable

ISO currency code for the window; null when empty or mixed.

currency_codestring nullable

Deprecated alias of currency; use currency.

start_datestring required
end_datestring required
pageinteger required
page_sizeinteger required
totalinteger required

Total number of LIVE sessions matching the window and account_type.

Changes

  • 3530675d2c2aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

  • 881910053958Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status