REreacherapp
GMV Max

This store's GMV Max campaigns, read from TikTok now

Changed on

TikTok's gmv_max/campaign/get, read on the request and limited to this shop's store: campaign ID, name, on/off state, TikTok's delivery status and times. Unlike gmv_max_campaigns_list (Reacher's synced copy, with metrics) it is never behind and includes campaigns created minutes ago. One campaign type per call. A campaign the sync has not seen yet is checked on TikTok before it is returned (up to 20 per call); unverified_omitted counts the rows left out, and a smaller page_size brings them back. Single shop only.

get/gmv-max/tiktok-campaigns

Request

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

Query parameters

campaign_type'product' | 'live'

Product or LIVE GMV Max.

status'active' | 'inactive' | 'deleted' nullable

TikTok's primary status: delivering, off, or deleted.

campaign_namestring nullable
campaign_idsstring nullable

Comma-separated, at most 100.

created_afterstring nullable

UTC, YYYY-MM-DD HH:MM:SS.

created_beforestring nullable

UTC, YYYY-MM-DD HH:MM:SS.

pageinteger
page_sizeinteger

Response

Successful Response

shop_idinteger required
advertiser_idstring required
store_idstring required

This shop's TikTok Shop (store) ID.

source'live'

Always live: read from TikTok on the request.

fetched_atstring nullable required
campaign_type'product' | 'live' required
unverified_omittedinteger

Rows TikTok returned that could not be proven to be on this shop's store, so were left out.

Changes