Retrieve orders attributed to specific marketing sources, campaigns, or ads with product/category breakdowns.

Parameters:

Parameter Type Required Default Description
store_id int Yes - Store identifier
filter_type string Yes - Primary filter type: "source", "platform", "campaign_id", "adset_id", "ad_id", or "referrer"
last_x_days int No - Get data for the last X days (e.g., 30 for last 30 days, 0 for today only). Alternative to date_start/date_end.
date_start string No - Start date in YYYY-MM-DD format (inclusive). Use with date_end or use last_x_days instead.
date_end string No - End date in YYYY-MM-DD format (inclusive). Use with date_start or use last_x_days instead.
report_type string No "orders" Report type: "orders", "products", or "product_categories"
source string No - Traffic source filter (required when filter_type="source"). Examples: "Meta Ads", "Google Ads", "Organic"
campaign string No - Campaign name filter (optional, use with source)
campaign_id int No - Numeric campaign ID (required when filter_type="campaign_id")
adset_id int No - Ad set/ad group ID (required when filter_type="adset_id")
ad_id int No - Individual ad ID (required when filter_type="ad_id")
platform string No - Platform filter (required when filter_type is campaign_id/adset_id/ad_id): "facebook", "google", "tiktok", "snapchat", "microsoft", "pinterest", "applovin"
referrer string No - Referrer domain (required when filter_type="referrer"). Use "Direct" for no referrer.
funnel_click string No - Position in funnel: "first", "last", or "middle"
attribution_window_days int No 180 Days to look back for attribution (1, 7, 14, 30, 60, 90, 180)
attribution_model string No "last_click_per_channel" Attribution model
customer_type string No - Filter by "new" or "returning" customers
limit int No 10 Max results to return (max: 100)

Examples: