Graph API Version

    Ad Account Delivery Estimate

    Returns the delivery estimate for a given ad set configuration in this ad account. You are not able to retrieve this field for inactive Lookalike Audiences.

    Reading

    Delivery estimate for a given ad set configuration in this ad account.

    Example

    Graph API Explorer
    GET /v19.0/{ad-account-id}/delivery_estimate 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-account-id}/delivery_estimate',
        '{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-account-id}/delivery_estimate",
        function (response) {
          if (response && !response.error) {
            /* handle the result */
          }
        }
    );
    /* make the API call */
    new GraphRequest(
        AccessToken.getCurrentAccessToken(),
        "/{ad-account-id}/delivery_estimate",
        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-account-id}/delivery_estimate"
                                          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

    ParameterDescription
    optimization_goal
    enum{NONE, APP_INSTALLS, AD_RECALL_LIFT, ENGAGED_USERS, EVENT_RESPONSES, IMPRESSIONS, LEAD_GENERATION, QUALITY_LEAD, LINK_CLICKS, OFFSITE_CONVERSIONS, PAGE_LIKES, POST_ENGAGEMENT, QUALITY_CALL, REACH, LANDING_PAGE_VIEWS, VISIT_INSTAGRAM_PROFILE, VALUE, THRUPLAY, DERIVED_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, CONVERSATIONS, IN_APP_VALUE, MESSAGING_PURCHASE_CONVERSION, SUBSCRIBERS, REMINDERS_SET, MEANINGFUL_CALL_ATTEMPT, MESSAGING_APPOINTMENT_CONVERSION}

    The optimization goal that you want the estimate for. You only get action predictions for optimization goals where actions make sense. See optimization_goals for allowed values.

    Required
    promoted_object
    Object

    The promoted object for the ad set that you want an estimate for. This is the same format as when you create an ad set.

    application_id
    int

    The ID of a Facebook Application. Usually related to mobile or canvas games being promoted on Facebook for installs or engagement

    pixel_id
    numeric string or integer

    The ID of a Facebook conversion pixel. Used with offsite conversion campaigns.

    custom_event_type
    enum{AD_IMPRESSION, RATE, TUTORIAL_COMPLETION, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, ADD_TO_CART, ADD_TO_WISHLIST, INITIATED_CHECKOUT, ADD_PAYMENT_INFO, PURCHASE, LEAD, COMPLETE_REGISTRATION, CONTENT_VIEW, SEARCH, SERVICE_BOOKING_REQUEST, MESSAGING_CONVERSATION_STARTED_7D, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, SPENT_CREDITS, LISTING_INTERACTION, D2_RETENTION, D7_RETENTION, OTHER}

    The event from an App Event of a mobile app, not in the standard event list.

    object_store_url
    URL

    The uri of the mobile / digital store where an application can be bought / downloaded. This is platform specific. When combined with the "application_id" this uniquely specifies an object which can be the subject of a Facebook advertising campaign.

    offer_id
    numeric string or integer

    The ID of an Offer from a Facebook Page.

    page_id
    Page ID

    The ID of a Facebook Page

    product_catalog_id
    numeric string or integer

    The ID of a Product Catalog. Used with Dynamic Product Ads.

    product_item_id
    numeric string or integer

    The ID of the product item.

    instagram_profile_id
    numeric string or integer

    The ID of the instagram profile id.

    product_set_id
    numeric string or integer

    The ID of a Product Set within an Ad Set level Product Catalog. Used with Dynamic Product Ads.

    event_id
    numeric string or integer

    The ID of a Facebook Event

    offline_conversion_data_set_id
    numeric string or integer

    The ID of the offline dataset.

    fundraiser_campaign_id
    numeric string or integer

    The ID of the fundraiser campaign.

    custom_event_str
    string

    The event from an App Event of a mobile app, not in the standard event list.

    mcme_conversion_id
    numeric string or integer

    The ID of a MCME conversion.

    conversion_goal_id
    numeric string or integer

    The ID of a Conversion Goal.

    offsite_conversion_event_id
    numeric string or integer

    The ID of a Offsite Conversion Event

    omnichannel_object
    Object

    app
    array<JSON object>

    pixel
    array<JSON object>

    Required
    onsite
    array<JSON object>

    whatsapp_phone_number
    string

    targeting_spec
    Targeting object

    The targeting specification for delivery estimate. See Advanced Targeting and Placement.

    Required

    Fields

    Reading from this edge will return a JSON formatted result:

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

    data

    A list of AdAccountDeliveryEstimate nodes.

    paging

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

    Error Codes

    ErrorDescription
    100Invalid parameter
    2641Your ad includes or excludes locations that are currently restricted
    200Permissions error
    80004There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.
    2654Failed to create custom audience
    368The action attempted has been deemed abusive or is otherwise disallowed
    105The number of parameters exceeded the maximum for this operation
    190Invalid OAuth 2.0 Access Token

    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.