Graph API Version

    Ad Report Run Insights

    Reading

    AdReportRunInsights

    Example

    Graph API Explorer
    GET /v21.0/{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();
    /* 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

    account_currency

    account_id
    numeric string

    account_id

    account_name
    string

    account_name

    action_values

    action_values

    actions

    actions

    activity_recency
    string

    activity_recency

    ad_click_actions

    ad_click_actions

    ad_format_asset
    string

    ad_format_asset

    ad_id
    numeric string

    ad_id

    ad_impression_actions

    ad_impression_actions

    ad_name
    string

    ad_name

    adset_id
    numeric string

    adset_id

    adset_name
    string

    adset_name

    age
    string

    age

    age_targeting
    string

    age_targeting

    app_id
    string

    app_id

    attribution_setting
    string

    attribution_setting

    auction_bid
    numeric string

    auction_bid

    auction_competitiveness
    numeric string

    auction_competitiveness

    auction_max_competitor_bid
    numeric string

    auction_max_competitor_bid

    average_purchases_conversion_value

    average_purchases_conversion_value

    body_asset
    AdAssetBody

    body_asset

    buying_type
    string

    buying_type

    call_to_action_asset
    AdAssetCallToActionType

    call_to_action_asset

    campaign_id
    numeric string

    campaign_id

    campaign_name
    string

    campaign_name

    canvas_avg_view_percent
    numeric string

    canvas_avg_view_percent

    canvas_avg_view_time
    numeric string

    canvas_avg_view_time

    catalog_segment_actions

    catalog_segment_actions

    catalog_segment_value

    catalog_segment_value

    catalog_segment_value_mobile_purchase_roas

    catalog_segment_value_mobile_purchase_roas

    catalog_segment_value_omni_purchase_roas

    catalog_segment_value_omni_purchase_roas

    catalog_segment_value_website_purchase_roas

    catalog_segment_value_website_purchase_roas

    clicks
    numeric string

    clicks

    coarse_conversion_value
    string

    coarse_conversion_value

    comparison_node
    AdsInsightsComparison

    comparison_node

    conversion_lead_rate

    conversion_lead_rate

    conversion_leads

    conversion_leads

    conversion_rate_ranking
    string

    conversion_rate_ranking

    conversion_values

    conversion_values

    conversions

    conversions

    converted_product_quantity

    converted_product_quantity

    converted_product_value

    converted_product_value

    cost_per_15_sec_video_view

    cost_per_15_sec_video_view

    cost_per_2_sec_continuous_video_view

    cost_per_2_sec_continuous_video_view

    cost_per_action_type

    cost_per_action_type

    cost_per_ad_click

    cost_per_ad_click

    cost_per_conversion

    cost_per_conversion

    cost_per_conversion_lead

    cost_per_conversion_lead

    cost_per_dda_countby_convs
    numeric string

    cost_per_dda_countby_convs

    cost_per_estimated_ad_recallers
    numeric string

    cost_per_estimated_ad_recallers

    cost_per_inline_link_click
    numeric string

    cost_per_inline_link_click

    cost_per_inline_post_engagement
    numeric string

    cost_per_inline_post_engagement

    cost_per_one_thousand_ad_impression

    cost_per_one_thousand_ad_impression

    cost_per_outbound_click

    cost_per_outbound_click

    cost_per_thruplay

    cost_per_thruplay

    cost_per_unique_action_type

    cost_per_unique_action_type

    cost_per_unique_click
    numeric string

    cost_per_unique_click

    cost_per_unique_conversion

    cost_per_unique_conversion

    cost_per_unique_inline_link_click
    numeric string

    cost_per_unique_inline_link_click

    cost_per_unique_outbound_click

    cost_per_unique_outbound_click

    country
    string

    country

    cpc
    numeric string

    cpc

    cpm
    numeric string

    cpm

    cpp
    numeric string

    cpp

    created_time
    string

    created_time

    creative_fingerprint
    string

    creative_fingerprint

    creative_media_type
    string

    creative_media_type

    ctr
    numeric string

    ctr

    date_start
    string

    date_start

    date_stop
    string

    date_stop

    dda_countby_convs
    numeric string

    dda_countby_convs

    dda_results
    list<AdsInsightsDdaResult>

    dda_results

    description_asset
    AdAssetDescription

    description_asset

    device_platform
    string

    device_platform

    dma
    string

    dma

    engagement_rate_ranking
    string

    engagement_rate_ranking

    estimated_ad_recall_rate
    numeric string

    estimated_ad_recall_rate

    estimated_ad_recall_rate_lower_bound
    numeric string

    estimated_ad_recall_rate_lower_bound

    estimated_ad_recall_rate_upper_bound
    numeric string

    estimated_ad_recall_rate_upper_bound

    estimated_ad_recallers
    numeric string

    estimated_ad_recallers

    estimated_ad_recallers_lower_bound
    numeric string

    estimated_ad_recallers_lower_bound

    estimated_ad_recallers_upper_bound
    numeric string

    estimated_ad_recallers_upper_bound

    fidelity_type
    string

    fidelity_type

    frequency
    numeric string

    frequency

    frequency_value
    string

    frequency_value

    full_view_impressions
    numeric string

    full_view_impressions

    full_view_reach
    numeric string

    full_view_reach

    gender
    string

    gender

    gender_targeting
    string

    gender_targeting

    hourly_stats_aggregated_by_advertiser_time_zone
    string

    hourly_stats_aggregated_by_advertiser_time_zone

    hourly_stats_aggregated_by_audience_time_zone
    string

    hourly_stats_aggregated_by_audience_time_zone

    hsid
    string

    hsid

    image_asset
    AdAssetImage

    image_asset

    impression_device
    string

    impression_device

    impressions
    numeric string

    impressions

    inline_link_click_ctr
    numeric string

    inline_link_click_ctr

    inline_link_clicks
    numeric string

    inline_link_clicks

    inline_post_engagement
    numeric string

    inline_post_engagement

    instagram_upcoming_event_reminders_set
    numeric string

    instagram_upcoming_event_reminders_set

    instant_experience_clicks_to_open
    numeric string

    instant_experience_clicks_to_open

    instant_experience_clicks_to_start
    numeric string

    instant_experience_clicks_to_start

    instant_experience_outbound_clicks

    instant_experience_outbound_clicks

    interactive_component_tap

    interactive_component_tap

    is_conversion_id_modeled
    string

    is_conversion_id_modeled

    is_video
    string

    is_video

    labels
    string

    labels

    landing_destination
    string

    landing_destination

    link_url_asset
    AdAssetLinkURL

    link_url_asset

    location
    string

    location

    marketing_messages_cost_per_delivered
    numeric string

    marketing_messages_cost_per_delivered

    marketing_messages_cost_per_link_btn_click
    numeric string

    marketing_messages_cost_per_link_btn_click

    marketing_messages_delivery_rate
    numeric string

    The number of messages delivered divided by the number of messages sent. Some messages may not be delivered, such as when a customer's device is out of service. This metric doesn't include messages sent to Europe and Japan.

    marketing_messages_link_btn_click_rate
    numeric string

    marketing_messages_link_btn_click_rate

    marketing_messages_media_view_rate
    numeric string

    marketing_messages_media_view_rate

    marketing_messages_phone_call_btn_click_rate
    numeric string

    marketing_messages_phone_call_btn_click_rate

    marketing_messages_quick_reply_btn_click_rate
    numeric string

    marketing_messages_quick_reply_btn_click_rate

    marketing_messages_read_rate
    numeric string

    marketing_messages_read_rate

    marketing_messages_spend
    numeric string

    marketing_messages_spend

    marketing_messages_website_purchase_values
    numeric string

    marketing_messages_website_purchase_values

    media_asset
    AdAssetMedia

    media_asset

    mobile_app_purchase_roas

    mobile_app_purchase_roas

    objective
    string

    objective

    optimization_goal
    string

    optimization_goal

    outbound_clicks

    outbound_clicks

    outbound_clicks_ctr

    outbound_clicks_ctr

    placement
    string

    placement

    platform_position
    string

    platform_position

    postback_sequence_index
    string

    postback_sequence_index

    product_id
    string

    product_id

    publisher_platform
    string

    publisher_platform

    purchase_roas

    purchase_roas

    qualifying_question_qualify_answer_rate
    numeric string

    qualifying_question_qualify_answer_rate

    quality_ranking
    string

    quality_ranking

    reach
    numeric string

    reach

    redownload
    string

    redownload

    region
    string

    region

    rule_asset
    AdAssetRule

    rule_asset

    shops_assisted_purchases
    string

    shops_assisted_purchases

    skan_campaign_id
    string

    skan_campaign_id

    skan_conversion_id
    string

    skan_conversion_id

    social_spend
    numeric string

    social_spend

    spend
    numeric string

    spend

    title_asset
    AdAssetTitle

    title_asset

    total_postbacks
    string

    total_postbacks

    total_postbacks_detailed

    total_postbacks_detailed

    total_postbacks_detailed_v4

    total_postbacks_detailed_v4

    unique_actions

    unique_actions

    unique_clicks
    numeric string

    unique_clicks

    unique_conversions

    unique_conversions

    unique_ctr
    numeric string

    unique_ctr

    unique_inline_link_click_ctr
    numeric string

    unique_inline_link_click_ctr

    unique_inline_link_clicks
    numeric string

    unique_inline_link_clicks

    unique_link_clicks_ctr
    numeric string

    unique_link_clicks_ctr

    unique_outbound_clicks

    unique_outbound_clicks

    unique_outbound_clicks_ctr

    unique_outbound_clicks_ctr

    unique_video_continuous_2_sec_watched_actions

    unique_video_continuous_2_sec_watched_actions

    unique_video_view_15_sec

    unique_video_view_15_sec

    updated_time
    string

    updated_time

    user_segment_key
    string

    user_segment_key

    video_15_sec_watched_actions

    video_15_sec_watched_actions

    video_30_sec_watched_actions

    video_30_sec_watched_actions

    video_asset
    AdAssetVideo

    video_asset

    video_avg_time_watched_actions

    video_avg_time_watched_actions

    video_continuous_2_sec_watched_actions

    video_continuous_2_sec_watched_actions

    video_p100_watched_actions

    video_p100_watched_actions

    video_p25_watched_actions

    video_p25_watched_actions

    video_p50_watched_actions

    video_p50_watched_actions

    video_p75_watched_actions

    video_p75_watched_actions

    video_p95_watched_actions

    video_p95_watched_actions

    video_play_actions

    video_play_actions

    video_play_curve_actions
    list<AdsHistogramStats>

    video_play_curve_actions

    video_play_retention_0_to_15s_actions
    list<AdsHistogramStats>

    video_play_retention_0_to_15s_actions

    video_play_retention_20_to_60s_actions
    list<AdsHistogramStats>

    video_play_retention_20_to_60s_actions

    video_play_retention_graph_actions
    list<AdsHistogramStats>

    video_play_retention_graph_actions

    video_thruplay_watched_actions

    video_thruplay_watched_actions

    video_time_watched_actions

    video_time_watched_actions

    website_ctr

    website_ctr

    website_purchase_roas

    website_purchase_roas

    wish_bid
    numeric string

    wish_bid

    Error Codes

    ErrorDescription
    100Invalid parameter

    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.