REreacherapp
Lives

LIVE GMV window totals

Changed on

Window totals for LIVE GMV for one shop, from customers.live_sessions. account_type picks the sessions: creator (default) = affiliate creators' LIVEs, valued at the Affiliate Center creator LIVE-attributed GMV shops see on /insights/transaction-analysis → LIVE streams; own = the shop's own brand-account LIVEs, valued at official LIVE GMV; all = both.

Differs from POST /metrics/summary field gmv — that is ALL affiliate revenue (video + live + product card). This isolates the LIVE-stream slice only. With account_type creator, the live_gmv field on /metrics/summary is the same number as a simple cross-shop scalar; this endpoint adds per-shop currency, session count, engagement and viewing duration.

Single-shop only — set x-shop-id to a specific shop ID. Defaults to the last 30 days ending today. Empty totals (live_count 0) are a normal 200 response — live-session coverage is data-presence driven.

post/lives/summary

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/lives/summary
  • 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 creator so live_gmv equals the live_gmv metric on POST /metrics/*; pass own or all for brand-account LIVE totals.

start_datestring date nullable

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

end_datestring date nullable

Inclusive window end (YYYY-MM-DD). Defaults to today (live sessions can land same-day, unlike the Seller Center daily rollup).

Response

Successful Response

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

Session scope the totals cover.

currencystring nullable

ISO currency code applying to the window (e.g. 'USD', 'GBP'). null when the window has no live-session data or (defensively) when rows somehow mix currencies for the same shop.

currency_codestring nullable

Deprecated alias of currency; use currency.

start_datestring required
end_datestring required
live_countinteger required

Number of LIVE sessions in the window.

live_gmvnumber required

SUM of LIVE GMV across the window: creator LIVE-attributed GMV (Affiliate Center) for creator sessions, official LIVE GMV for the shop's own-account sessions.

items_soldinteger required

SUM of units sold across the LIVE sessions.

avg_engagement_ratenumber nullable

Window-level engagement rate as a decimal (0.0–1.0+): SUM(likes+comments+shares) / SUM(views). null when views are 0. Not the average of per-session rates.

avg_viewing_durationinteger nullable

Average viewing duration in seconds across LIVE sessions; null when empty.

Changes

  • 3530675d2c2aRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status

  • 291230805105Revision changes
    • info

      api operation id lives_summary_lives_summary_post removed and replaced with lives_summary

    • info

      added the optional property to the response with the status

    • info

      response property currency_code deprecated