Get Ad Performance Summary
GET/api/advertising/performance/summary
Headline advertising totals for the window, with a per-platform breakdown.
advertising:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires the advertising.view permission. Token scope: advertising:read (personal access and OAuth tokens).
Shared filters (all optional): platforms (one or more of amazon_ads, ebay, google_ads, walmart_connect, meta_ads, tiktok_ads, comma-separated or as an array; the older single platform is still accepted and merged in); ad_account_ids, campaign_ids, product_ids (comma-separated string or array of integers); date_from / date_to (date-only, m/d/Y, in the app timezone; default window is the 30 days ending yesterday, and date_to must be on or after date_from). Money is in tenant currency. Ratios are fractions (0.25 = 25%) and are null when their denominator is zero. provisional is true when any day in the window may still be restated by the platform. per_page is accepted but ignored.
Fields: date_from, date_to (resolved window, YYYY-MM-DD), spend, attributed_sales, impressions, clicks, attributed_orders, acos, roas, tacos (spend / total revenue of the advertised sales channels), poas (attributed contribution before ads / spend; null when no spend is mapped to products), poas_estimated, break_even_poas (always 1.0), break_even_acos (the ACoS at which ads break even), blended_poas (all channel contribution / all ad spend), contribution_after_ads, provisional, mixed_attribution_windows (platforms in the window use different attribution windows), unmapped_spend (spend on items with no product) and by_platform.
Each by_platform entry: platform, label, spend, attributed_sales, acos, roas, poas, poas_estimated, break_even_acos, contribution_after_ads, accounts, attribution_window_days, last_synced_at, attribution_note (e.g. that Meta per-product purchases are estimated) and provisional.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.