Sign in
Lives

Creator LIVE-attributed GMV window totals

Window totals for creator LIVE-attributed GMV for one shop, from customers.live_sessions (the Affiliate Center LIVE value shops see on /insights/transaction-analysis → LIVE streams).

Differs from POST /metrics/summary field gmv — that is ALL affiliate revenue (video + live + product card). This isolates the LIVE-stream slice only. 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 body

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
currency_codestring 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.

start_datestring required
end_datestring required
live_countinteger required

Number of affiliate LIVE sessions in the window.

live_gmvnumber required

SUM of creator LIVE-attributed GMV (affiliate_gmv) across the window — the Affiliate Center LIVE value.

items_soldinteger required

SUM of affiliate units sold across 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

No recorded changes to this endpoint across all 1 revision of this API.