REreacherapp
GMV Max

GMV Max campaign detail

Changed on

Detail for one campaign: name, status, ad type, budget, ROAS bid, last sync time, plus the campaign's daily metric rows (spend, impressions, clicks, orders, gross_revenue, CPC, CPM, CTR, ROAS). Single shop only — the caller must address the campaign's owning shop via x-shop-id. For multi-shop callers, use the /campaigns list endpoint to discover which shop owns a campaign before requesting its detail.

get/gmv-max/campaigns/{campaign_id}

Request

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

Path parameters

campaign_idstring required

Response

Successful Response

campaign_idstring required
campaign_namestring nullable
budgetnumber nullable
target_roasnumber nullable

Target ROAS set on the campaign (TikTok's roas_bid).

roas_bidnumber nullable

Deprecated alias of target_roas; use target_roas.

last_synced_atstring nullable

ISO 8601 UTC of the most recent TikTok sync.

currencystring nullable

ISO currency code for the shop's region.

raw_dataobject nullable

Raw TikTok campaign payload as last synced.

Changes

  • 291230805105Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      api operation id campaign_detail_gmv_max_campaigns__campaign_id__get removed and replaced with gmv_max_campaign_detail

    • 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

    • 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

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status