Insights Tools
Tools for retrieving Facebook advertising performance metrics and analytics.
Insights Tools
Tools for retrieving performance metrics across campaigns, ad sets, ads, and ad accounts. Insights include spend, ROAS, reach, impressions, conversions, and more.
Common Parameters
All insights tools share these parameters for controlling what data is returned:
| Prop | Type | Default |
|---|---|---|
fields | string[] | - |
time_range | object | undefined | - |
time_increment | string | number | - |
level | string | - |
breakdowns | string[] | undefined | - |
action_attribution_windows | string[] | undefined | - |
action_breakdowns | string[] | undefined | - |
get_campaign_insights
Retrieve aggregated performance metrics for a Facebook campaign, combining data from all its ad sets and ads.
Parameters
| Prop | Type | Default |
|---|---|---|
campaign_id | string | - |
Plus all common parameters above.
Example
get_adset_insights
Retrieve performance metrics for a specific Facebook ad set. Aggregates data from all ads within the ad set.
Parameters
| Prop | Type | Default |
|---|---|---|
adset_id | string | - |
Plus all common parameters above.
Example
get_ad_insights
Retrieve performance metrics for a specific Facebook ad, including spend, impressions, clicks, CTR, CPM, and ROAS. Supports breakdown dimensions and custom date ranges.
Parameters
| Prop | Type | Default |
|---|---|---|
ad_id | string | - |
Plus all common parameters above.
Example
get_ad_account_insights
Retrieve aggregated performance metrics across all campaigns for a Facebook ad account. Supports level parameter for granular breakdown.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
Plus all common parameters above.