Ad Campaign Message Delivery Estimate

Updated: May 19, 2025

Reading

The campaign delivery estimation for marketing messages

Example

Select language

HTTPPHP SDKJavaScript SDKAndroid SDKiOS SDK

---

GET /v25.0/{ad-set-id}/message_delivery_estimate HTTP/1.1  
Host: graph.facebook.com

Try it in Graph API Explorer

If you want to learn how to use the Graph API, read our Using Graph API guide

Parameters

Parameter	Description
bid_amount int64	The bid amount of this campaign
lifetime_budget int64	The lifetime budget of this campaign
lifetime_in_days int64	The campaign lifetime duration in days
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, ENGAGED_PAGE_VIEWS, VALUE, THRUPLAY, DERIVED_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, CONVERSATIONS, IN_APP_VALUE, MESSAGING_PURCHASE_CONVERSION, MESSAGING_DEEP_CONVERSATION_AND_FOLLOW, SUBSCRIBERS, REMINDERS_SET, MEANINGFUL_CALL_ATTEMPT, PROFILE_VISIT, PROFILE_AND_PAGE_ENGAGEMENT, ADVERTISER_SILOED_VALUE, AUTOMATIC_OBJECTIVE, MESSAGING_APPOINTMENT_CONVERSION}	The optimization goal of this campaign
pacing_type enum {STANDARD, DISABLED, DAY_PARTING, NO_PACING, PROBABILISTIC_PACING, PROBABILISTIC_PACING_V2}	The pacing type of this campaign
promoted_object Object	The promoted object of this campaign --- 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. object_store_urls list<URL> The vec of 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. job_listing_id numeric string or integer The ID of the marketplace job listing. 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 boosted_product_set_id numeric string or integer The ID of the Boosted Product Set within an Ad Set level Product Catalog. Should only be present when the advertiser has opted into Product Set Boosting. lead_ads_form_event_source_type enum{inferred, meta_source, offsite_crm, offsite_web, onsite_crm, onsite_crm_single_event, onsite_clo_dep_aet, onsite_web, onsite_p2b_call, onsite_messaging, qualified_lead_file} The event source of lead ads form. lead_ads_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. lead_ads_custom_event_str string The event from an App Event of a mobile app, not in the standard event list. lead_ads_offsite_conversion_type enum{default, clo} The offsite conversion type for lead ads value_semantic_type enum {VALUE, MARGIN, LIFETIME_VALUE} The semantic of the event value to be using for optimization variation enum {OMNI_CHANNEL_SHOP_AUTOMATIC_DATA_COLLECTION, PRODUCT_SET_AND_APP, PRODUCT_SET_AND_IN_STORE, PRODUCT_SET_AND_OMNICHANNEL, PRODUCT_SET_AND_PHONE_CALL, PRODUCT_SET_AND_WEBSITE, PRODUCT_SET_AND_WEBSITE_AND_PHONE_CALL, PRODUCT_SET_WEBSITE_APP_AND_INSTORE} Variation of the promoted object for a PCA ad passback_pixel_id numeric string or integer ID of the pixel used for tracking passback events passback_application_id numeric string or integer ID of the application used for tracking passback events product_set_optimization enum{enabled, disabled} Enum defining whether or not the ad should be optimized for the promoted product set full_funnel_objective enum{OFFER_CLAIMS, PAGE_LIKES, EVENT_RESPONSES, POST_ENGAGEMENT, WEBSITE_CONVERSIONS, LINK_CLICKS, VIDEO_VIEWS, LOCAL_AWARENESS, PRODUCT_CATALOG_SALES, LEAD_GENERATION, BRAND_AWARENESS, STORE_VISITS, REACH, APP_INSTALLS, MESSAGES, OUTCOME_AWARENESS, OUTCOME_ENGAGEMENT, OUTCOME_LEADS, OUTCOME_SALES, OUTCOME_TRAFFIC, OUTCOME_APP_PROMOTION} Enum defining the full funnel objective of the campaign dataset_split_id numeric string or integer ID of the dataset split used to perform additional optimization on the dataset dataset_split_ids array<numeric string> IDs of the dataset splits used to perform additional optimization on the dataset lead_ads_selected_pixel_id numeric string or integer The selected pixel id for lead ads conversion leads optimization custom_attribution_source_ids array<numeric string> IDs of the custom attribution sources used for tracking passback events multi_event_product int64 Identifies which action-to-action product the advertiser is using product_sales_channel enum {ONLINE, IN_STORE, OMNI} ProductSalesChannel of the promoted object for Omni L3 DA SBLI ads anchor_event_config JSON object Configuration for anchor event in multi-event optimization campaigns multi_event_conversion_info JSON object Configuration for multi-event conversion info in CLO campaigns live_video_destination string The live video destination type for live video ads smart_pse_enabled boolean Whether Smart Product Set Expansion is enabled for this campaign. smart_pse_setting enum{ENABLED, DISABLED} Setting for Smart Product Set Expansion. Uses an enum instead of a boolean to avoid TAO null handling issues. lead_ads_follow_up_event enum{whatsapp_conversations} The selected lead follow-up event for lead ads campaigns. omnichannel_object Object --- app array<JSON object> pixel array<JSON object> required onsite array<JSON object> Show child parameters whats_app_business_phone_number_id numeric string or integer whatsapp_phone_number string Show child parameters
targeting_spec Targeting object	The targeting setup of this campaign

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of MessageDeliveryEstimate nodes.

paging

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

Error Codes

Error Code	Description
100	Invalid 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.