Get performance report
reddit_ads_get_reportFetch performance metrics for a Reddit Ads account over a date range, with filters and breakdowns, to analyze campaign, ad group, or ad performance.
Instructions
Get performance metrics for an ad account. Metric keys come back lowercase. spend, cpc, cpv, ecpm, conversion_*ecpa, app_installecpa, app_install_skan and app_install_*revenue are micro-currency (divide by 1000000); conversion*_total_value is in cents. Data can take up to 6 hours to settle.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Uppercase metric names. Default IMPRESSIONS, CLICKS, SPEND, CTR, CPC, ECPM. Others: REACH, FREQUENCY, VIDEO_STARTED, VIDEO_WATCHED_25_PERCENT..VIDEO_WATCHED_100_PERCENT, VIDEO_VIEWABLE_IMPRESSIONS, CPV, CONVERSION_PAGE_VISIT_CLICKS, CONVERSION_PURCHASE_CLICKS, CONVERSION_PURCHASE_VIEWS, CONVERSION_PURCHASE_TOTAL_VALUE, CONVERSION_PURCHASE_ECPA, CONVERSION_SIGN_UP_CLICKS, CONVERSION_LEAD_CLICKS, CONVERSION_ADD_TO_CART_CLICKS, KEY_CONVERSION_TOTAL_COUNT, KEY_CONVERSION_ECPA, APP_INSTALL_INSTALL_COUNT, etc. | |
| filter | No | Filter like campaign:id==123 or ad_group:name=@brand or ad:effective_status==ACTIVE; comma separated conditions are ORed | |
| ends_at | Yes | End date YYYY-MM-DD (inclusive) or ISO 8601 (rounded to the hour) | |
| max_pages | No | Default 10 | |
| page_size | No | ||
| starts_at | Yes | Start date YYYY-MM-DD or ISO 8601 (rounded to the hour) | |
| breakdowns | No | Up to 3 breakdowns (4 when COUNTRY and REGION are both used). Use at most one of KEYWORD, COMMUNITY, INTEREST, LANGUAGE and do not combine them with geo, OS_TYPE, GALLERY_ITEM_ID or CAROUSEL_CARD; HOUR only for ranges up to 7 days | |
| time_zone_id | No | IANA time zone, e.g. America/New_York | |
| ad_account_id | No | Ad account ID (t2_... or a2_...). Defaults to REDDIT_ADS_ACCOUNT_ID. | |
| custom_column_ids | No | ||
| conversion_metrics | No | [{conversion_field, action_sources: [WEBSITE|APP|PHYSICAL_STORE|OTHER]}] | |
| conversion_custom_events | No | [{name, metrics: [{metric_type: VIEWS|CLICKS|ECPA|TOTAL_VALUE|TOTAL_ITEMS|AVG_VALUE|ROAS, action_sources}]}] |