Ad performance metrics
get_insightsMetrics for the ad account or an object inside it. Date ranges use the AD ACCOUNT time zone. Spend, impressions, clicks, CTR, CPC, CPM, reach, frequency, actions and cost per action, with the attribution setting and date window, for the ad account or one campaign, ad set or ad. Dates use the ad account time zone; money values are already in account currency, not minor units. Rows include the campaign, ad set and ad ids for their level. Optional: a breakdown (age, gender, country, region, placement, device, hour, creative asset), time_increment slices, extra field groups (include), a status filter, a minimum spend, sort order, attribution windows and totals. Up to 500 rows per call, fewer when the rows would not fit in one tool result; complete=false means more exist. next_after is given only when the page fit whole: pass it as after with the same other fields for the next rows; without it narrow the level, object, breakdown or date window. notes say which fields or rows Meta may leave out: a missing value is not zero. Read-only and free: changes nothing and does not count toward the monthly change limit. An identical read within 30 seconds may return the same data (see data_age_seconds).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Row order, e.g. spend_descending. Reach and frequency sorts do not work with the hourly breakdown. | |
| after | No | next_after from the previous call with the same other fields, to read the next rows. | |
| level | No | Aggregation level of the rows. Omit to report at the level of object_id. | |
| limit | No | Rows per call, 1 to 500. Default 500. | |
| totals | No | true adds summary: totals for the whole result, as Meta computes them. | |
| include | No | Extra field groups: names (account, campaign, ad set and ad names); results (results, cost_per_result, objective, optimization goal; not at level account); value (action_values, purchase_roas, website_purchase_roas; not at level account); links (inline and outbound link clicks, CTR and cost); video (plays, 25–100% watched, ThruPlay, average watch time; not with region or hourly); ranking (quality, engagement rate and conversion rate rankings). | |
| min_spend | No | Only rows that spent more than this in the window, in the ad account currency (not minor units); 0 drops rows without spend. | |
| object_id | No | Campaign, ad set or ad id, or act_<ad account id>, from a read of this ad account. Omit for the whole ad account. | |
| breakdowns | No | Split the rows by one Meta breakdown. publisher_platform with platform_position is the placement split; hourly_stats_aggregated_by_advertiser_time_zone is by hour in the ad account time zone and has no reach or frequency; device_platform is mobile or desktop; image_asset, body_asset, title_asset and description_asset split ads by creative asset. | |
| connection | No | Which connected ad account to use: the connection id from start_here or the ad account number (act_123 or 123). Needed only when several ad accounts are connected. | |
| time_range | No | Explicit inclusive window, as an object {"since":"2026-08-01","until":"2026-08-31"}, not a JSON string. | |
| date_preset | No | Relative window in the ad account time zone, e.g. today, yesterday, last_7d, last_30d, this_month, maximum. Default last_7d (applied in run). Ignored when time_range is given. | |
| time_increment | No | Time slices: a number of days per row (1 to 90), "monthly", or "all_days" for one row per window. | |
| effective_status | No | Only rows of objects whose effective status is one of these, e.g. ["ACTIVE"]; needs level campaign, adset or ad. List ARCHIVED or DELETED to include such objects. | |
| attribution_windows | No | Report actions per attribution window, e.g. ["7d_click","1d_view"]: each action gets a key for every window that has a value. Omit for the attribution setting of the ad sets. |