--from (required) | <from> | Inclusive start date, yyyy-MM-dd. |
--to (required) | <to> | Inclusive end date, yyyy-MM-dd. |
--level | channel|campaign|ad=campaign | What each result row represents. Defaults to campaign. |
--metrics | '<json>' | Metrics to show per row. Defaults to spend, impressions, clicks, ctr, cpc, cpm. reach, conversions and costPerConversion need level ad. |
--order-by | spend|impressions|clicks|ctr|cpc|cpm|reach|conversions|costPerConversion=spend | Metric to rank rows by. Defaults to spend. |
--order-direction | asc|desc=desc | Sort direction. Defaults to desc (highest first). |
--limit | <1-50>=10 | Maximum rows to return (1-50). Defaults to 10. |
--channels | '<json>' | Channel filter for level channel or campaign, e.g. [“META”, “GOOGLE_SEARCH”]. Omit for every channel. |
--source | META|TIKTOK|GOOGLE|LINKEDIN|SNAPCHAT|REDDIT=META | Level ad only: the ad platform to read ads from. Defaults to META. |
--campaign-name | <campaign-name> | Level ad only: keep ads whose campaign name contains this. |
--ad-set-name | <ad-set-name> | Level ad only: keep ads whose ad set name contains this (Meta). |
--conversion-event | <conversion-event> | Level ad only: the platform conversion event to count (e.g. a Meta action_type). Defaults to the workspace’s primary mapped conversion for that platform. |
--time-series | true|false=false | Level channel or campaign: also return totals per time bucket. |
--granularity | day|week|month=day | Bucket width for the time series: day, week or month. |
--compare-with-previous-period | true|false=false | Level channel or campaign: compare with the equally long period just before from. |
