List of ads
Get list of ads
Path parameters
Shop ID
Query parameters
Page number
Number of records per page
Start of the statistics period, as a Unix timestamp (seconds). The insights metrics are aggregated from this time.
End of the statistics period, as a Unix timestamp (seconds). The insights metrics are aggregated up to this time.
Comma-separated list of additional insights fields to include in the response. When specified, only the listed fields are returned inside insights (in addition to the always-present base metrics).
Performance
- ad_performance_session — Overall performance
- spend — Amount spent
- reach — Instant Experience reach
- impressions — Impressions
- clicks — Clicks (all)
- frequency — Frequency
- cpp — CPP
- cpm — CPM
- cpc — CPC
- ctr — CTR
- cost_per_1000_accounts_center_reach — Cost per 1000 accounts center reach
- cost_per_result — Cost per result
- avg_purchase_conversion_value — Average purchase conversion value
- indicator_result — Result
- result_roas — Result ROAS
Engagement
- ad_engagement_session — Engagement
- link_click — Link clicks
- like — Facebook likes
- comment — Post comments
- post_engagement — Post engagements
- post_reaction — Post reactions
- post — Post shares
- onsite_conversion_post_save — Post saves
- photo_view — Photo views
- video_view — Video plays (≥3s)
- inline_link_click_ctr — CTR (link click-through rate)
- outbound_click — Outbound clicks
- onsite_conversion_messaging_conversation_started_7d — Messaging conversations started
- onsite_conversion_messaging_first_reply — New messaging contacts
- onsite_conversion_messaging_block — Messaging blocks
- video_thruplay_watched_actions — ThruPlays
- video_play_actions — Video plays
- video_p25_watched_actions — Video plays at 25%
- video_p50_watched_actions — Video plays at 50%
- video_p75_watched_actions — Video plays at 75%
- video_p95_watched_actions — Video plays at 95%
- video_p100_watched_actions — Video plays at 100%
- estimated_ad_recallers — Estimated ad recall lift (people)
- cost_per_outbound_click — Cost per outbound click
- cost_per_thruplay — Cost per ThruPlay
- outbound_clicks_ctr — Outbound CTR
- cost_per_post_engagement — Cost per post engagement
- estimated_ad_recall_rate — Estimated ad recall lift rate
- cost_per_estimated_ad_recallers — Cost per estimated ad recall lift
- cost_per_messaging_conversation_started — Cost per messaging conversation started
Conversion
Leads
- lead — Leads
- website_lead — Website leads
- offline_lead — Offline leads
- meta_lead — Meta leads
- lead_conversion_value — Lead conversion value
- website_lead_conversion_value — Website lead conversion value
- offline_lead_conversion_value — Offline lead conversion value
- meta_lead_conversion_value — Meta lead conversion value
- cost_per_lead — Cost per lead
Purchases
- omni_purchase — Purchases
- inapp_omni_purchase — In-app purchases
- website_omni_purchase — Website purchases
- offline_omni_purchase — Offline purchases
- meta_omni_purchase — Meta purchases
- omni_purchase_conversion_value — Purchase conversion value
- inapp_omni_purchase_conversion_value — In-app purchase conversion value
- website_omni_purchase_conversion_value — Website purchase conversion value
- offline_omni_purchase_conversion_value — Offline purchase conversion value
- meta_omni_purchase_conversion_value — Meta purchase conversion value
- cost_per_omni_purchase — Cost per purchase
Checkout initiated
- omni_initiated_checkout — Checkout initiated
- inapp_omni_initiated_checkout — In-app checkout initiated
- website_omni_initiated_checkout — Website checkout initiated
- offline_omni_initiated_checkout — Offline checkout initiated
- meta_omni_initiated_checkout — Meta checkout initiated
- omni_initiated_checkout_conversion_value — Checkout initiation conversion value
- inapp_omni_initiated_checkout_conversion_value — In-app checkout initiation conversion value
- website_omni_initiated_checkout_conversion_value — Website checkout initiation conversion value
- offline_omni_initiated_checkout_conversion_value — Offline checkout initiation conversion value
- meta_omni_initiated_checkout_conversion_value — Meta checkout initiation conversion value
- cost_per_omni_initiated_checkout — Cost per checkout initiated
Registrations completed
- omni_complete_registration — Registrations completed
- inapp_omni_complete_registration — In-app registrations completed
- website_omni_complete_registration — Website registrations completed
- offline_omni_complete_registration — Offline registrations completed
- omni_complete_registration_conversion_value — Registration completion conversion value
- inapp_omni_complete_registration_conversion_value — In-app registration completion conversion value
- website_omni_complete_registration_conversion_value — Website registration completion conversion value
- offline_omni_complete_registration_conversion_value — Offline registration completion conversion value
- cost_per_omni_complete_registration — Cost per registration completed
Content views
- omni_view_content — Content views
- inapp_omni_view_content — In-app content views
- website_omni_view_content — Website content views
- offline_omni_view_content — Offline content views
- meta_omni_view_content — Meta content views
- omni_view_content_conversion_value — Content view conversion value
- inapp_omni_view_content_conversion_value — In-app content view conversion value
- website_omni_view_content_conversion_value — Website content view conversion value
- offline_omni_view_content_conversion_value — Offline content view conversion value
- meta_omni_view_content_conversion_value — Meta content view conversion value
- cost_per_omni_view_content — Cost per content view
Searches
- omni_search — Searches
- inapp_omni_search — In-app searches
- website_omni_search — Website searches
- offline_omni_search — Offline searches
- omni_search_conversion_value — Search conversion value
- inapp_omni_search_conversion_value — In-app search conversion value
- website_omni_search_conversion_value — Website search conversion value
- offline_omni_search_conversion_value — Offline search conversion value
- cost_per_omni_search — Cost per search
Add to cart
- omni_add_to_cart — Add to cart
- inapp_omni_add_to_cart — In-app add to cart
- website_omni_add_to_cart — Website add to cart
- offline_omni_add_to_cart — Offline add to cart
- meta_omni_add_to_cart — Meta add to cart
- omni_add_to_cart_conversion_value — Add-to-cart conversion value
- inapp_omni_add_to_cart_conversion_value — In-app add-to-cart conversion value
- website_omni_add_to_cart_conversion_value — Website add-to-cart conversion value
- offline_omni_add_to_cart_conversion_value — Offline add-to-cart conversion value
- meta_omni_add_to_cart_conversion_value — Meta add-to-cart conversion value
- cost_per_omni_add_to_cart — Cost per add to cart
Add to wishlist
- omni_add_to_wishlist — Add to wishlist
- inapp_omni_add_to_wishlist — In-app add to wishlist
- website_omni_add_to_wishlist — Website add to wishlist
- offline_omni_add_to_wishlist — Offline add to wishlist
- meta_omni_add_to_wishlist — Meta add to wishlist
- omni_add_to_wishlist_conversion_value — Add-to-wishlist conversion value
- inapp_omni_add_to_wishlist_conversion_value — In-app add-to-wishlist conversion value
- website_omni_add_to_wishlist_conversion_value — Website add-to-wishlist conversion value
- offline_omni_add_to_wishlist_conversion_value — Offline add-to-wishlist conversion value
- meta_omni_add_to_wishlist_conversion_value — Meta add-to-wishlist conversion value
- cost_per_omni_add_to_wishlist — Cost per add to wishlist
Product customizations
- customize_product_total — Product customizations
- inapp_customize_product_total — In-app product customizations
- website_customize_product_total — Website product customizations
- offline_customize_product_total — Offline product customizations
- customize_product_total_conversion_value — Product customization conversion value
- inapp_customize_product_total_conversion_value — In-app product customization conversion value
- website_customize_product_total_conversion_value — Website product customization conversion value
- offline_customize_product_total_conversion_value — Offline product customization conversion value
- cost_per_customize_product_total — Cost per product customization
Trials started
- start_trial_total — Trials started
- inapp_start_trial_total — In-app trials started
- website_start_trial_total — Website trials started
- offline_start_trial_total — Offline trials started
- start_trial_total_conversion_value — Trial start conversion value
- inapp_start_trial_total_conversion_value — In-app trial start conversion value
- website_start_trial_total_conversion_value — Website trial start conversion value
- offline_start_trial_total_conversion_value — Offline trial start conversion value
- cost_per_start_trial_total — Cost per trial started
Subscriptions
- subscribe_total — Subscriptions
- inapp_subscribe_total — In-app subscriptions
- website_subscribe_total — Website subscriptions
- offline_subscribe_total — Offline subscriptions
- subscribe_total_conversion_value — Subscription conversion value
- inapp_subscribe_total_conversion_value — In-app subscription conversion value
- website_subscribe_total_conversion_value — Website subscription conversion value
- offline_subscribe_total_conversion_value — Offline subscription conversion value
- cost_per_subscribe_total — Cost per subscription
Applications submitted
- submit_application_total — Applications submitted
- inapp_submit_application_total — In-app applications submitted
- website_submit_application_total — Website applications submitted
- offline_submit_application_total — Offline applications submitted
- meta_submit_application_total — Meta applications submitted
- submit_application_total_conversion_value — Application submission conversion value
- inapp_submit_application_total_conversion_value — In-app application submission conversion value
- website_submit_application_total_conversion_value — Website application submission conversion value
- offline_submit_application_total_conversion_value — Offline application submission conversion value
- meta_submit_application_total_conversion_value — Meta application submission conversion value
- cost_per_submit_application_total — Cost per application submitted
Contacts
- contact_total — Contacts
- inapp_contact_total — In-app contacts
- website_contact_total — Website contacts
- offline_contact_total — Offline contacts
- contact_total_conversion_value — Contact conversion value
- inapp_contact_total_conversion_value — In-app contact conversion value
- website_contact_total_conversion_value — Website contact conversion value
- offline_contact_total_conversion_value — Offline contact conversion value
- cost_per_contact_total — Cost per contact
Landing page views
- landing_page_view — Landing page views
- inapp_landing_page_view — In-app landing page views
- website_landing_page_view — Website landing page views
- cost_per_landing_page_view — Cost per landing page view
Orders
- order_created — Orders created
- order_shipped — Orders shipped
Purchase ROAS
- purchase_roas — Purchase ROAS
- inapp_purchase_roas — In-app purchase ROAS
- website_purchase_roas — Website purchase ROAS
Response
Success
Changes
No recorded changes to this endpoint across all 1 revision of this API.