Skip to main content

List Ad Performance

GET 

/api/advertising/performance

Aggregated advertising performance for the window, one row per group_by key.

Required scope: advertising:read

Grant 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).

group_by (default campaign): platform, account, campaign, ad_group, product, target or day. Rows are ordered by spend descending (by date ascending for day). key is the grouped id (platform value for platform, YYYY-MM-DD for day) and name its label; spend that cannot be tied to a group has a null key and the name Unassigned (or Historical spend (no campaign) for campaigns). product rows only include spend mapped to a product.

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.

Pagination: per_page default 10, max 500; page.

Row fields: group_by, key, name, impressions, clicks, spend, attributed_sales, attributed_orders, attributed_units, acos (spend / attributed sales), roas (attributed sales / spend), ctr, cpc, cvr (orders / clicks), provisional. product rows also carry poas (profit on ad spend: contribution before ads / spend), net_poas, contribution_after_ads, unit_contribution_before_ads, poas_estimated (true when costs were estimated), actual_sales (the product's real sales on the advertised channels), attributed_share (attributed / actual, capped at 1) and attributed_exceeds_actual (the platform claims more sales than were recorded).

Grouped by product, attributed_sales, attributed_units and attributed_orders count only purchases of that product itself (Amazon's same-SKU attribution, where reported), and each row adds other_sku_sales: sales its ads drove on other products. Account, campaign and platform groupings keep the platform's total attributed sales.

Request​

Responses​

OK

Response Headers
    Content-Type