Get Insights Breakdown
adsap_get_insights_breakdownLive Meta API call: get spend and performance metrics sliced by demographic or placement dimensions (age, gender, platform, country). Not cached.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 50, max 200 | |
| date_to | No | YYYY-MM-DD. Required if no date_preset. | |
| metrics | No | Any of: spend, impressions, clicks, link_clicks, outbound_clicks, conversions, purchase_conversions, lead_conversions, add_to_cart_conversions, conversion_value, purchase_value, video_views (=75% completion), video_thruplay, video_p25, video_p50, video_p75, video_p95, video_p100, lpv (landing page views), post_engagement, video_3s (3-sec plays), contact, checkout, registration, app_install, app_activation, subscribe, start_trial, view_content, add_payment_info, submit_application, add_to_wishlist, search, schedule, donate, find_location, customize_product, app_purchase, app_add_to_cart, app_initiate_checkout, app_add_payment_info, app_complete_registration, app_content_view, app_search, app_add_to_wishlist, app_level_achieved, app_achievement_unlocked, app_tutorial_completion, app_spent_credits, app_rate, subscribe_value (conversion value), start_trial_value (conversion value), ctr (link CTR), ctr_all, cpc (cost/link click), cpc_all, cpm, cost_per_conversion, purchase_roas, aov, conversion_rate, hook_rate, hold_rate, lpv_rate, cost_per_lpv, cost_per_lead, cost_per_atc, cost_per_thruplay, cost_per_post_engagement, cost_per_purchase, cost_per_subscribe, cost_per_start_trial, cost_per_view_content, cost_per_add_payment_info, cost_per_submit_application, cost_per_add_to_wishlist, cost_per_search, cost_per_schedule, cost_per_donate, cost_per_find_location, cost_per_customize_product, outbound_ctr. Defaults to spend, impressions, link_clicks, ctr, cpc, cpm, results, cost_per_result, purchase_roas. | |
| sort_by | No | ||
| group_by | No | Secondary grouping by entity level | |
| sort_dir | No | ||
| date_from | No | YYYY-MM-DD. Required if no date_preset. | |
| entity_ids | No | Filter to specific IDs | |
| date_preset | No | Required if no date_from/date_to | |
| entity_type | Yes | ||
| ad_account_id | Yes | Must include act_ prefix | |
| breakdown_dimensions | Yes | One or more dimensions to slice results by. Options: age (13-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65+), gender (male/female/unknown), country (ISO codes), region, publisher_platform (facebook/instagram/messenger/audience_network), platform_position (feed/story/reels/etc), device_platform (mobile/desktop), impression_device. Max 2 dimensions recommended — Meta rejects some combinations. |