REreacherapp
GMV Max

Live GMV Max report (from TikTok)

Changed on

Runs TikTok's GMV Max report for this shop on the request — the same data and grains as TikTok's gmv_max/report/get, typically under an hour old, where the other GMV Max metric tools read Reacher's sync and can be hours behind.

Choose dimensions (campaign_id, item_group_id = product SPU, item_id = post, room_id = LIVE room, duration, stat_time_day or stat_time_hour) and metrics (cost, net_cost, orders, cost_per_order, gross_revenue, roi, roas_bid = target ROI, product/creative/LIVE metrics). Product-, post- and LIVE-level rows need filtering.campaign_ids. Dates are in the ad account's time zone: up to 1 day with stat_time_hour, 30 days with stat_time_day, 365 days otherwise.

Rows pass TikTok's dimensions/metrics objects through unchanged (numbers arrive as strings). An identical request within 5 minutes is served from cache (cached: true). Each shop may make 120 uncached reports per hour. Single shop only.

post/gmv-max/report

Request

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

Request body

start_datestring date required

Inclusive start date (YYYY-MM-DD) in the ad account's time zone.

end_datestring date required

Inclusive end date (YYYY-MM-DD) in the ad account's time zone. Up to 1 day with stat_time_hour, 30 days with stat_time_day, 365 days with no time dimension.

dimensionsstring[] required

Grouping. advertiser_id and campaign_id stand alone; item_group_id, item_id, room_id and duration need filtering.campaign_ids; item_id also needs filtering.item_group_ids; duration needs filtering.room_ids or filtering.item_group_ids. stat_time_day / stat_time_hour split time and cannot be used alone.

metricsstring[] required

Metrics and attributes. Money metrics: cost, net_cost, orders, cost_per_order, gross_revenue, roi. Campaign attributes include roas_bid (the target ROI). roi is 0.00 when cost is 0 — that is a placeholder, not a ratio.

sort_fieldstring nullable

A metric to sort by, e.g. cost.

sort_type'ASC' | 'DESC' nullable
enable_total_metricsboolean

Also return totals across every page in total_metrics.

pageinteger
page_sizeinteger

Response

Successful Response

shop_idinteger required
advertiser_idstring required
store_idstring required
currencystring required

ISO currency code for the shop's region.

source'live'

Always live: fetched from TikTok, not from Reacher's sync.

fetched_atstring nullable required

When TikTok returned this data. Repeating the same request within 5 minutes returns this same result (see cached).

cachedboolean required

True when served from the 5-minute cache rather than a new TikTok call.

total_metricsobject nullable

Totals across every page; present when enable_total_metrics was set.

Changes