Marketing API Version

Ad Report Run Insights

Reading

Insights results of this Ad Report Run

Example

Graph API Explorer
GET /v2.12/{ad-report-run-id}/insights HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{ad-report-run-id}/insights',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{ad-report-run-id}/insights",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ad-report-run-id}/insights",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{ad-report-run-id}/insights"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {}, "summary": {} }

data

A list of AdsInsights nodes.

paging

For more details about pagination, see the Graph API guide.

summary

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=account_currency).

FieldDescription
account_currency
string

Currency that is used by your ad account.

account_id
numeric string

The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.

account_name
string

The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.

action_values

The total value of all conversions attributed to your ads.

actions

The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.

ad_id
numeric string

The unique ID of the ad you're viewing in reporting.

ad_name
string

The name of the ad you're viewing in reporting.

adset_id
numeric string

The unique ID of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting.

adset_name
string

The name of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting.

buying_type
string

The method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying.

call_to_action_clicks
numeric string

The number of times people clicked the call-to-action button on your ad.

campaign_id
numeric string

The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.

campaign_name
string

The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.

canvas_avg_view_percent
numeric string

The average percentage of the Facebook Canvas that people saw. Canvas is a screen that opens on mobile after a person clicks the Canvas link in your ad. It may include a series of interactive or multimedia components, including video, images, product catalogs and more.

canvas_avg_view_time
numeric string

The average total time, in seconds, that people spent viewing a Facebook Canvas. Canvas is a screen that opens on mobile after a person clicks the Canvas link in your ad. It may include a series of interactive or multimedia components, including video, images, product catalogs and more.

canvas_component_avg_pct_view

The average percentage of time spent viewing each component of a Facebook Canvas. Canvas is a screen that opens on mobile after a person clicks the Canvas link in your ad. It may include a series of interactive or multimedia components, including video, images, product catalogs and more.

clicks
numeric string

The number of clicks on your ads.

comparison_node
AdsInsightsComparison

Parent node that encapsulates fields to be compared (current time range Vs comparison time range)

cost_per_10_sec_video_view

The average cost for each 10-second video view.

cost_per_action_type

The average cost of a relevant action.

cost_per_estimated_ad_recallers
numeric string

The average cost for each estimated ad recall lift. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

cost_per_inline_link_click
numeric string

The average cost of each inline link click.

cost_per_inline_post_engagement
numeric string

The average cost of each inline post engagement.

cost_per_outbound_click

The average cost for each outbound click.

cost_per_total_action
numeric string

The average cost of a relevant action.

cost_per_unique_action_type

The average cost of each unique action. This metric is estimated.

cost_per_unique_click
numeric string

The average cost for each unique click (all). This metric is estimated.

cost_per_unique_inline_link_click
numeric string

The average cost of each unique inline link click. This metric is estimated.

cost_per_unique_outbound_click

The average cost for each unique outbound click. This metric is estimated.

cpc
numeric string

The average cost for each click (all).

cpm
numeric string

The average cost for 1,000 impressions.

cpp
numeric string

The average cost to reach 1,000 people. This metric is estimated.

ctr
numeric string

The percentage of times people saw your ad and performed a click (all).

date_start
string

The start date for your data. This is controlled by the date range you've selected for your reporting view.

date_stop
string

The end date for your data. This is controlled by the date range you've selected for your reporting view.

estimated_ad_recall_rate
numeric string

The rate at which an estimated number of additional people, when asked, would remember seeing your ads within 2 days. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

estimated_ad_recallers
numeric string

An estimate of the number of additional people who may remember seeing your ads, if asked, within 2 days. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

frequency
numeric string

The average number of times each person saw your ad. This metric is estimated.

impressions
numeric string

The number of times your ads were on screen.

inline_link_click_ctr
numeric string

The percentage of time people saw your ads and performed an inline link click.

inline_link_clicks
numeric string

The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.

inline_post_engagement
numeric string

The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.

mobile_app_purchase_roas

The total return on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.

objective
string

The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.

outbound_clicks

The number of clicks on links that take people off Facebook-owned properties.

outbound_clicks_ctr

The percentage of times people saw your ad and performed an outbound click.

reach
numeric string

The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. This metric is estimated.

relevance_score
AdgroupRelevanceScore

A rating from 1 to 10 that estimates how well your target audience is responding to your ad. This score is shown after your ad receives more than 500 impressions. It's only visible when looking at reporting for ads and does not appear for ad sets and campaigns.

social_clicks
numeric string

The number of clicks (all) when your ad was displayed with social information, which shows other Facebook friends who engaged with your Facebook Page or ad.

social_impressions
numeric string

The number of times your ads were viewed when displayed with social information, which shows Facebook friends who engaged with your Facebook Page or ad.

social_reach
numeric string

The number of people who saw your ad when displayed with social information, which shows other Facebook friends who engaged with your Facebook Page or ad. This metric is estimated.

social_spend
numeric string

The total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).

spend
numeric string

The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.

total_action_value
numeric string

The total value of all conversions attributed to your ads.

total_actions
numeric string

The total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.

total_unique_actions
numeric string

The number of people who took an action that was attributed to your ads. This metric is estimated.

unique_actions

The number of people who took an action that was attributed to your ads. This metric is estimated.

unique_clicks
numeric string

The number of people who performed a click (all). This metric is estimated.

unique_ctr
numeric string

The percentage of people who saw your ad and performed a unique click (all). This metric is estimated.

unique_inline_link_click_ctr
numeric string

The percentage of times people saw your ad and performed a link click. Inline click-through rate uses a fixed 1-day-click attribution window. This metric is estimated.

unique_inline_link_clicks
numeric string

The number of people who performed an inline link click. This metric is estimated.

unique_link_clicks_ctr
numeric string

The percentage of people who saw your ad and performed a link click. This metric is estimated.

unique_outbound_clicks

The number of people who performed an outbound click. This metric is estimated.

unique_outbound_clicks_ctr

The percentage of people who saw your ad and performed an outbound click. This metric is estimated.

unique_social_clicks
numeric string

The number of people who performed a click (all) on your ad when it was displayed with social information, which shows other Facebook friends who engaged with your Facebook Page or ad. This metric is estimated.

video_10_sec_watched_actions

The number of times your video was watched for an aggregate of at least 10 seconds, or for nearly its total length, whichever happened first.

video_30_sec_watched_actions

The number of times your video was watched for an aggregate of at least 30 seconds, or for nearly its total length, whichever happened first.

video_avg_percent_watched_actions

The average percentage of your video that people watched.

video_avg_time_watched_actions

The average time a video was watched.

video_p100_watched_actions

The number of times your video was watched at 100% of its length, including watches that skipped to this point.

video_p25_watched_actions

The number of times your video was watched at 25% of its length, including watches that skipped to this point.

video_p50_watched_actions

The number of times your video was watched at 50% of its length, including watches that skipped to this point.

video_p75_watched_actions

The number of times your video was watched at 75% of its length, including watches that skipped to this point.

video_p95_watched_actions

The number of times your video was watched at 95% of its length, including watches that skipped to this point.

website_ctr

The percentage of times people saw your ad and performed a link click.

website_purchase_roas

The total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.

Validation Rules

ErrorDescription
275Cannot determine the target object for this request. Currently supported objects include ad account, business account and associated objects.

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.