Group the Insights results into different sets.
The following fields cannot be requested when specifying a breakdown:
The Insights API can return several metrics which are estimated or in-development. In some cases a metric may be both estimated and in-development. Insights breakdown values are estimated. For more information, see Insights API, Estimated and Deprecated Metrics.
The following breakdowns are available.
frequency_valueis used with
reachonly. For example, how frequently a unique user saw an ad.
video_assetbreakdowns are not available at the ad account level for assets used in Dynamic Creative.
The following call groups the results by
curl -G \ -d "breakdowns=age,gender" \ -d "fields=impressions" \ -d "access_token=<ACCESS_TOKEN>" \ "https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"
Hourly stats are now an available breakdown using the following breakdowns:
See Combining Breakdowns for limits on number of breakdowns you may request with the hourly breakdown. Hourly breakdowns do not support unique fields, which are any fields prepended with
frequency fields will return 0 when hourly breakdowns are in use.
curl -G \ -d "fields=impressions" \ -d "breakdowns=hourly_stats_aggregated_by_audience_time_zone" \ -d "access_token=<ACCESS_TOKEN>" \ "https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"
Group results in the
actions field. You can use the following breakdowns for
The following are the possible breakdowns that can be supplied into the
Sum up all values returned in
actions. Note this result may not equal
total_actions since fields returned in
actions are hierarchical includes detailed actions not counted.
total_actions - 33 page_engagement - 10 post_engagement - 10 link_click - 2 comment - 3 post_reaction - 3 like - 2 mobile_app_install - 12 app_custom_event - 11 app_custom_event.fb_mobile_activate_app - 6 app_custom_event.other - 5
In this example, post_engagement is a sum of
post_reaction is the count of all Reactions, including likes.
total_actions is a sum of top-level actions for an object such as
Due to storage constraints, only some permutations of breakdowns are available. Permutations marked with an asterisk (*) can be joined with
action_destination which is the name for
video_* fields cannot be requested with any hourly stats breakdowns.