/

Docs from a schema DocsSign in

Docs
History
Schema
Generate

Filter operations

Account & Billing6

Affiliate Orders1

AI Search8

Analytics8

Automations26

Briefs15

Campaign Content & Challenges11

Campaigns25

Cohort Analysis5

Contracts8

Creator Messages12

Creators9

CRM Groups3

CRM Roster4

CRM Tags2

Discord6

Discovery Agent7

Email Accounts1

Finance5

GMV Max59

get/gmv-max/campaignsList GMV Max campaigns
post/gmv-max/campaignsCreate a GMV Max campaign
get/gmv-max/campaigns/{campaign_id}/metricsDaily GMV Max campaign metrics
get/gmv-max/campaigns/{campaign_id}/creative-metricsDaily GMV Max creative metrics (incl. video view rate)
get/gmv-max/dashboardGMV Max dashboard KPIs
get/gmv-max/campaigns/{campaign_id}GMV Max campaign detail
patch/gmv-max/campaigns/{campaign_id}Update a GMV Max campaign
get/gmv-max/creativesGMV Max creatives for a campaign
get/gmv-max/spark-codesGMV Max spark code sync state
get/gmv-max/templatesGMV Max automation quick-start templates
get/gmv-max/automationsList GMV Max automations
post/gmv-max/automationsCreate a GMV Max automation
get/gmv-max/automations/{automation_id}GMV Max automation detail
put/gmv-max/automations/{automation_id}Update a GMV Max automation
delete/gmv-max/automations/{automation_id}Delete (soft) a GMV Max automation
get/gmv-max/automations/{automation_id}/runsGMV Max automation run history
get/gmv-max/automations/{automation_id}/activitiesGMV Max automation activity log
post/gmv-max/automations/{automation_id}/stopStop a GMV Max automation
post/gmv-max/spark-codes/syncSync specific spark codes to TikTok
post/gmv-max/spark-codes/sync-allQueue every unsynced spark code for sync
post/gmv-max/products/timeseriesDaily product-level GMV Max metrics (per product, per campaign)
post/gmv-max/videos/summaryPer-video GMV Max spend and performance (across campaigns)
post/gmv-max/products/summaryProduct-level GMV Max window totals + GMV Max Ads overview
get/gmv-max/campaigns/{campaign_id}/settingsGMV Max campaign settings (normalized)
get/gmv-max/campaigns/{campaign_id}/delivery-statusGMV Max creative delivery-status breakdown
get/gmv-max/campaigns/{campaign_id}/spend-by-surfaceGMV Max spend by delivery surface
get/gmv-max/campaigns/{campaign_id}/changesGMV Max campaign settings change log
post/gmv-max/reportLive GMV Max report (from TikTok)
get/gmv-max/bid-recommendationTikTok's recommended target ROAS and daily budget
get/gmv-max/storeThis shop's TikTok Shop as GMV Max sees it
get/gmv-max/store-availabilityCan this store run a Product GMV Max campaign on all products
get/gmv-max/tiktok-campaignsThis store's GMV Max campaigns, read from TikTok now
get/gmv-max/identitiesIdentities usable for GMV Max on this store
get/gmv-max/asset-occupancyIs an identity or product already used by Shopping Ads
get/gmv-max/exclusive-authorizationDoes this ad account hold the store's GMV Max exclusive authorization
post/gmv-max/exclusive-authorizationMake this shop's ad account the store's GMV Max account
post/gmv-max/postsPosts usable in a Product GMV Max campaign
get/gmv-max/store-productsThis store's products and whether each can join GMV Max
get/gmv-max/campaigns/{campaign_id}/sessionsMax delivery and creative boost sessions on a GMV Max campaign
post/gmv-max/campaigns/{campaign_id}/sessionsStart a max delivery or creative boost session
delete/gmv-max/campaigns/{campaign_id}/sessions/{session_id}End a max delivery or creative boost session
patch/gmv-max/campaigns/{campaign_id}/sessions/{session_id}Change a session's budget or schedule
get/gmv-max/excluded-creatorsList GMV Max excluded creators
post/gmv-max/excluded-creatorsExclude a creator from GMV Max
get/gmv-max/bof-settingsGet GMV Max BOF auto-exclude settings
put/gmv-max/bof-settingsUpdate GMV Max BOF auto-exclude settings
delete/gmv-max/excluded-creators/{handle}Remove a GMV Max creator exclusion
get/gmv-max/protected-creatorsList GMV Max protected creators
post/gmv-max/protected-creatorsProtect a creator from GMV Max auto-exclusion
post/gmv-max/protected-creators/importBulk-protect creators from GMV Max auto-exclusion
delete/gmv-max/protected-creators/{handle}Remove a GMV Max creator from the allow-list
get/gmv-max/excluded-videosList GMV Max excluded videos
post/gmv-max/excluded-videosExclude a video from GMV Max
post/gmv-max/excluded-videos/bulkExclude many videos from GMV Max
delete/gmv-max/excluded-videos/{video_id}Remove a GMV Max video exclusion
get/gmv-max/campaign-exclusionsList GMV Max per-campaign video exclusions
post/gmv-max/campaign-exclusions/previewPreview a GMV Max per-campaign exclusion
post/gmv-max/campaign-exclusions/excludeExclude videos from GMV Max campaigns
post/gmv-max/campaign-exclusions/add-backAdd videos back to a GMV Max campaign

Halo Effect Tracker6

Integrations1

Lists4

Lives4

Meta Ads16

Metrics2

Orders1

P&L12

Personalization5

Products7

Promotion Snapshots3

Promotions13

Sample Review Intelligence (internal)2

Samples24

Seller Center5

Shared Dashboards4

Shop GMV2

Shop Health4

Shop Performance3

Shop Report1

Shops1

Social Intelligence30

Spark Codes1

Strategy (internal)2

Target Collabs3

Targets & Blacklist6

Usage Rights4

Video Intelligence3

Videos5

Weekly Report3

Workflows20

GMV Max

Changes to Live GMV Max report (from TikTok)

post/gmv-max/report

Oct 16, 20268c30101a864b Revision changes
- info
  endpoint added