Connector

Facebook Ads Connector to Microsoft Excel

Own your Facebook Ads data in Microsoft Excel with OWOX Data Marts. Collect granular, analytics-ready Facebook Ads data, control schema and refresh logic, and reuse it across Microsoft Excel and AI Insights.

Get started free

Endpoints

Facebook Ads endpoints

15 Facebook Ads endpoints you can import. Each lands in its own table in your warehouse.

  • Ad

    Individual ads with their creative, status, and links to their campaign and ad set.

    32 fieldsfacebook_ads_ad_group
  • Ad Account

    Your ad account settings, status, currency, and billing details.

    61 fieldsfacebook_ads_ad_account
  • Ad Account User

    Users with access to an ad account and their assigned roles.

    2 fieldsfacebook_ads_ad_account_user
  • Ad Creatives

    The images, videos, text, and other visual elements used in your ads.

    63 fieldsfacebook_ads_ad_account_adcreatives
  • Ad Insights

    Daily performance metrics for each ad — impressions, clicks, spend, and conversions.

    100 fieldsTime seriesfacebook_ads_ad_account_insights
  • Ad Insights by Ad Set

    Daily ad set performance with reach deduplicated to match Meta Ads Manager.

    92 fieldsTime seriesfacebook_ads_ad_account_insights_by_adset
  • Ad Insights by Age and Gender

    Daily ad performance broken down by audience age range and gender.

    102 fieldsTime seriesfacebook_ads_ad_account_insights_by_age_and_gender
  • Ad Insights by Campaign

    Daily campaign performance with reach deduplicated to match Meta Ads Manager.

    89 fieldsTime seriesfacebook_ads_ad_account_insights_by_campaign
  • Ad Insights by Country

    Daily ad performance broken down by the country where your audience is located.

    101 fieldsTime seriesfacebook_ads_ad_account_insights_by_country
  • Ad Insights by Device Platform

    Daily ad performance broken down by the device type your audience used.

    101 fieldsTime seriesfacebook_ads_ad_account_insights_by_device_platform
  • Ad Insights by Link URL Asset

    Daily ad performance broken down by the link URL shown in your ads.

    101 fieldsTime seriesfacebook_ads_ad_account_insights_by_link_url_asset
  • Ad Insights by Product ID

    Daily ad performance broken down by individual product from your catalog.

    101 fieldsTime seriesfacebook_ads_ad_account_insights_by_product_id
  • Ad Insights by Publisher Platform and Position

    Daily ad performance broken down by where your ads appeared — platform and placement position.

    102 fieldsTime seriesfacebook_ads_ad_account_insights_by_publisher_platform_and_position
  • Ad Insights by Region

    Daily ad performance broken down by the region where your audience is located.

    101 fieldsTime seriesfacebook_ads_ad_account_insights_by_region
  • Ads

    Individual ads with their status, creative, and campaign hierarchy.

    24 fieldsfacebook_ads_ad_account_ads

Data schema

Facebook Ads data schema

Ad 32 fields · facebook_ads_ad_group
Facebook Ads Ad fields
FieldTypeDescription
idSTRINGThe ID of this ad.
account_idSTRINGThe ID of the ad account that this ad belongs to.
ad_active_timeSTRINGThe time from when the ad was recently active
ad_review_feedbackOBJECTThe review feedback for this ad after it is reviewed.
ad_schedule_end_timeDATETIMEAn optional parameter that defines the end time of an individual ad. If no end time is defined, the ad will run on the campaign’s schedule.
ad_schedule_start_timeDATETIMEAn optional parameter that defines the start time of an individual ad. If no start time is defined, the ad will run on the campaign’s schedule.
adlabelsARRAYAd labels associated with this ad
adsetOBJECTAd set that contains this ad
adset_idSTRINGID of the ad set that contains the ad
bid_amountINTEGERBid amount for this ad which will be used in auction. This value would be the same as the bid_amount field on the ad set.
campaignOBJECTAd campaign that contains this ad
campaign_idSTRINGID of the ad campaign that contains this ad
configured_statusSTRINGThe configured status of the ad. Use status instead of this field.
conversion_domainSTRINGThe domain where conversions happen. The field is no longer required for creation or update since June 2023. Note that this field should contain only the first and second level domains, and not the full URL. For example facebook.com.
created_timeDATETIMETime when the ad was created.
creative_idSTRINGUnique ID for the ad creative
creative_effective_object_story_idSTRINGThe ID of a page post to use in an ad, regardless of whether its an organic or unpublished page post
creative_nameSTRINGName of the ad creative as seen in the ad accounts library
creative_object_story_specSTRINGObject story spec containing page_id and other details
creative_url_tagsSTRINGA set of query string parameters which will replace or be appended to urls clicked from page post ads
creative_asset_groups_specOBJECTThis field is used to create ads using the Flexible ad format. You can read more about that here
effective_statusSTRINGThe effective status of the ad. The status could be effective either because of its own status, or the status of its parent units. WITH_ISSUES is available for version 3.2 or higher. IN_PROCESS is available for version 4.0 or higher
issues_infoARRAYIssues for this ad that prevented it from delivering
last_updated_by_app_idSTRINGIndicates the app used for the most recent update of the ad.
nameSTRINGName of the ad.
preview_shareable_linkSTRINGA link that enables users to preview ads in different placements
recommendationsARRAYIf there are recommendations for this ad, this field includes them. Otherwise, it is not included in the response. Field not included in redownload mode.
source_adOBJECTThe source ad that this ad is copied from
source_ad_idSTRINGThe source ad id that this ad is copied from
statusSTRINGThe configured status of the ad. The field returns the same value as configured_status. Use this field, instead of configured_status.
tracking_specsARRAYWith tracking specs, you log actions taken by people on your ad. This field takes arguments identical to action spec. See Tracking and Conversion Specs.
updated_timeDATETIMETime when this ad was updated.
Ad Account 61 fields · facebook_ads_ad_account
Facebook Ads Ad Account fields
FieldTypeDescription
idSTRINGThe string act\_{ad_account_id}.
account_idSTRINGThe ID of the Ad Account.
account_statusINTEGERStatus of the account:
ageNUMBERAmount of time the ad account has been open, in days.
agency_client_declarationSTRINGDetails of the agency advertising on behalf of this client account, if applicable. Requires Business Manager Admin privileges.
amount_spentSTRINGCurrent amount spent by the account with respect to spend_cap. Or total amount in the absence of spend_cap.
attribution_specARRAYDeprecated due to iOS 14 changes. Please visit the changelog for more information.
balanceSTRINGBill amount due for this Ad Account.
brand_safety_content_filter_levelsARRAYBrand safety content filter levels set for in-content ads (Facebook in-stream videos and Ads on Facebook Reels) and Audience Network along with feed ads (Facebook Feed, Instagram feed, Facebook Reels feed and Instagram Reels feed) if applicable.
businessSTRINGThe Business Manager, if this ad account is owned by one
business_citySTRINGCity for business address
business_country_codeSTRINGCountry code for the business address
business_nameSTRINGThe business name for the account
business_stateSTRINGState abbreviation for business address
business_streetSTRINGFirst line of the business street address for the account
business_street2STRINGSecond line of the business street address for the account
business_zipSTRINGZip code for business address
can_create_brand_lift_studyBOOLEANIf we can create a new automated brand lift study under the Ad Account.
capabilitiesARRAYList of capabilities an Ad Account can have. See capabilities
created_timeDATETIMEThe time the account was created in ISO 8601 format.
currencySTRINGThe currency used for the account, based on the corresponding value in the account settings. See supported currencies
default_dsa_beneficiarySTRINGThis is the default value for creating L2 object of dsa_beneficiary
default_dsa_payorSTRINGThis is the default value for creating L2 object of dsa_payor
disable_reasonINTEGERThe reason why the account was disabled. Possible reasons are:
end_advertiserSTRINGThe entity the ads will target. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID.
end_advertiser_nameSTRINGThe name of the entity the ads will target.
existing_customersARRAYThe custom audience ids that are used by advertisers to define their existing customers. This definition is primarily used by Automated Shopping Ads.
expired_funding_source_detailsSTRINGID = ID of the payment method
extended_credit_invoice_groupSTRINGThe extended credit invoice group that the ad account belongs to
failed_delivery_checksARRAYFailed delivery checks
fb_entityINTEGERfb_entity
funding_sourceSTRINGID of the payment method. If the account does not have a payment method it will still be possible to create ads but these ads will get no delivery. Not available if the account is disabled
funding_source_detailsSTRINGID = ID of the payment method
has_migrated_permissionsBOOLEANWhether this account has migrated permissions
io_numberSTRINGThe Insertion Order (IO) number.
is_attribution_spec_system_defaultBOOLEANIf the attribution specification of ad account is generated from system default values
is_direct_deals_enabledBOOLEANWhether the account is enabled to run Direct Deals
is_in_3ds_authorization_enabled_marketBOOLEANIf the account is in a market requiring to go through payment process going through 3DS authorization
is_notifications_enabledBOOLEANGet the notifications status of the user for this ad account. This will return true or false depending if notifications are enabled or not
is_personalINTEGERIndicates if this ad account is being used for private, non-business purposes. This affects how value-added tax (VAT) is assessed. Note: This is not related to whether an ad account is attached to a business.
is_prepay_accountBOOLEANIf this ad account is a prepay. Other option would be a postpay account.
is_tax_id_requiredBOOLEANIf tax id for this ad account is required or not.
line_numbersARRAYThe line numbers
media_agencySTRINGThe agency, this could be your own business. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID. In absence of one, you can use NONE or UNFOUND.
min_campaign_group_spend_capSTRINGThe minimum required spend cap of Ad Campaign.
min_daily_budgetINTEGERThe minimum daily budget for this Ad Account
nameSTRINGName of the account. If not set, the name of the first admin visible to the user will be returned.
offsite_pixels_tos_acceptedBOOLEANIndicates whether the offsite pixel Terms Of Service contract was signed. This feature can be accessible before v2.9
ownerSTRINGThe ID of the account owner
partnerSTRINGThis could be Facebook Marketing Partner, if there is one. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID. In absence of one, you can use NONE or UNFOUND.
rf_specOBJECTReach and Frequency limits configuration. See Reach and Frequency
spend_capSTRINGThe maximum amount that can be spent by this Ad Account. When the amount is reached, all delivery stops. A value of 0 means no spending-cap. Setting a new spend cap only applies to spend AFTER the time at which you set it. Value specified in basic unit of the currency, for example 'cents' for USD.
tax_idSTRINGTax ID
tax_id_statusINTEGERVAT status code for the account.
tax_id_typeSTRINGType of Tax ID
timezone_idINTEGERThe timezone ID of this ad account
timezone_nameSTRINGName for the time zone
timezone_offset_hours_utcNUMBERTime zone difference from UTC (Coordinated Universal Time).
tos_acceptedOBJECTChecks if this specific ad account has signed the Terms of Service contracts. Returns 1, if terms were accepted.
user_tasksARRAYuser_tasks
user_tos_acceptedOBJECTChecks if a user has signed the Terms of Service contracts related to the Business that contains a specific ad account. Must include user's access token to get information. This verification is not valid for system users.
Ad Account User 2 fields · facebook_ads_ad_account_user
Facebook Ads Ad Account User fields
FieldTypeDescription
idSTRINGID of the App Scoped User
nameSTRINGUser public full name
Ad Creatives 63 fields · facebook_ads_ad_account_adcreatives
Facebook Ads Ad Creatives fields
FieldTypeDescription
idSTRINGUnique ID for an ad creative, numeric string.
account_idSTRINGAd account ID for the account this ad creative belongs to.
actor_idSTRINGThe actor ID (Page ID or User ID) of this creative
ad_disclaimer_specSTRINGAd disclaimer data on creative for additional information on ads.
adlabelsARRAYAd Labels associated with this creative. Used to group it with related ad objects.
applink_treatmentSTRINGUsed for Dynamic Ads. Specify what action should occur if a person clicks a link in the ad, but the business' app is not installed on their device. For example, open a webpage displaying the product, or open the app in an app store on the person's mobile device.
asset_feed_specSTRINGUsed for Dynamic Creative to automatically experiment and deliver different variations of an ad's creative. Specifies an asset feed with multiple images, text and other assets used to generate variations of an ad. Formatted as a JSON string.
authorization_categorySTRINGSpecifies whether ad was configured to be labeled as a political ad or not. See Facebook Advertising Policies. This field cannot be used for Dynamic Ads.
bodySTRINGThe body of the ad. Not supported for video post creatives
branded_contentSTRINGbranded_content
branded_content_sponsor_page_idSTRINGID for page representing business which runs Branded Content ads. See Creating Branded Content Ads.
bundle_folder_idSTRINGThe Dynamic Ad's bundle folder ID
call_to_action_typeSTRINGType of call to action button in your ad. This determines the button text and header text for your ad. See Ads Guide for campaign objectives and permitted call to action types.
categorization_criteriaSTRINGThe Dynamic Category Ad's categorization field, e.g. brand
category_media_sourceSTRINGThe Dynamic Ad's rendering mode for category ads
collaborative_ads_lsb_image_bank_idSTRINGUsed for CPAS local delivery image bank
contextual_multi_adsSTRINGcontextual_multi_ads
creative_sourcing_specSTRINGcreative_sourcing_spec
degrees_of_freedom_specSTRINGSpecifies the types of transformations that are enabled for the given creative
destination_set_idSTRINGThe ID of the Product Set for a Destination Catalog that will be used to link with Travel Catalogs
dynamic_ad_voiceSTRINGUsed for Store Traffic Objective inside Dynamic Ads. Allows you to control the voice of your ad. If set to DYNAMIC, page name and profile picture in your ad post come from the nearest page location. If set to STORY_OWNER, page name and profile picture in your ad post come from the main page location.
effective_authorization_categorySTRINGSpecifies whether ad is a political ad or not. See Facebook Advertising Policies. This field cannot be used for Dynamic Ads.
effective_instagram_media_idSTRINGThe ID of an Instagram post to use in an ad
effective_object_story_idSTRINGThe ID of a page post to use in an ad, regardless of whether it's an organic or unpublished page post
enable_direct_installBOOLEANWhether Direct Install should be enabled on supported devices
enable_launch_instant_appBOOLEANWhether Instant App should be enabled on supported devices
facebook_branded_contentSTRINGStores fields for Facebook Branded Content
image_cropsSTRINGA JSON object defining crop dimensions for the image specified. See image crop reference for more details
image_hashSTRINGImage hash for ad creative. If provided, do not add image_url. See image library for more details.
image_urlSTRINGA URL for the image for this creative. We save the image at this URL to the ad account's image library. If provided, do not include image_hash.
instagram_permalink_urlSTRINGURL for a post on Instagram you want to run as an ad. Also known as Instagram media.
instagram_user_idSTRINGInstagram actor ID
interactive_components_specSTRINGSpecification for all the interactive components that would show up on the ad
link_destination_display_urlSTRINGOverwrites the display URL for link ads when object_url is set to a click tag
link_og_idSTRINGThe Open Graph (OG) ID for the link in this creative if the landing page has OG tags
link_urlSTRINGIdentify a specific landing tab on your Facebook page by the Page tab's URL. See connection objects for retrieving Page tab URLs. You can add app_data parameters to the URL to pass data to a Page's tab.
messenger_sponsored_messageSTRINGUsed for Messenger sponsored message. JSON string with message for this ad creative. See Messenger Platform, Send API Reference.
nameSTRINGName of this ad creative as seen in the ad account's library. This field has a limit of 100 characters.
object_idSTRINGID for Facebook object being promoted with ads or relevant to the ad or ad type. For example a page ID if you are running ads to generate Page Likes. See promoted_object.
object_store_urlSTRINGiTunes or Google Play of the destination of an app ad
object_story_idSTRINGID of a Facebook Page post to use in an ad. You can get this ID by querying the posts of the page. If this post includes an image, it should not exceed 8 MB. Facebook will upload the image from the post to your ad account's image library. If you create an unpublished page post via object_story_spec at the same time as creating the ad, this ID will be null. However, the effective_object_story_id will be the ID of the page post regardless of whether it's an organic or unpublished page post.
object_story_specSTRINGUse if you want to create a new unpublished page post and turn the post into an ad. The Page ID and the content to create a new unpublished page post. Specify link_data, photo_data, video_data, text_data or template_data with the content.
object_typeSTRINGThe type of Facebook object you want to advertise. Allowed values are:
object_urlSTRINGURL that opens if someone clicks your link on a link ad. This URL is not connected to a Facebook page.
page_welcome_messageSTRINGPage welcome message for CTM ads
photo_album_source_object_story_idSTRINGphoto_album_source_object_story_id
place_page_set_idSTRINGThe ID of the page set for this creative. See theLocal Awareness guide
platform_customizationsSTRINGUse this field to specify the exact media to use on different Facebook placements. You can currently use this setting for images and videos. Facebook replaces the media originally defined in ad creative with this media when the ad displays in a specific placements. For example, if you define a media here for instagram, Facebook uses that media instead of the media defined in the ad creative when the ad appears on Instagram.
playable_asset_idSTRINGThe ID of the playable asset in this creative
portrait_customizationsSTRINGThis field describes the rendering customizations selected for portrait mode ads like IG Stories, FB Stories, IGTV, etc
product_dataARRAYproduct_data
product_set_idSTRINGUsed for Dynamic Ad. An ID for a product set, which groups related products or other items being advertised.
recommender_settingsSTRINGUsed for Dynamic Ads. Settings to display Dynamic ads based on product recommendations.
source_instagram_media_idSTRINGThe ID of an Instagram post for creating ads
statusSTRINGThe status of the creative. WITH_ISSUES and IN_PROCESS are available for 4.0 or higher
template_urlSTRINGUsed for Dynamic Ads when you want to use third-party click tracking. See Dynamic Ads, Click Tracking and Templates.
template_url_specSTRINGUsed for Dynamic Ads when you want to use third-party click tracking. See Dynamic Ads, Click Tracking and Templates.
thumbnail_idSTRINGthumbnail_id
thumbnail_urlSTRINGURL for a thumbnail image for this ad creative. You can provide dimensions for this with thumbnail_width and thumbnail_height. See example.
titleSTRINGTitle for link ad, which does not belong to a page.
url_tagsSTRINGA set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only
use_page_actor_overrideBOOLEANUsed for App Ads. If true, we display the Facebook page associated with the app ads.
video_idSTRING
Ad Insights 100 fields · facebook_ads_ad_account_insights
Facebook Ads Ad Insights fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe percentage of results you received out of all the views of your ads.
resultsARRAYThe number of results you received out of all the views of your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Ad Set 92 fields · facebook_ads_ad_account_insights_by_adset
Facebook Ads Ad Insights by Ad Set fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe number of people who saw your ads at least once, deduplicated at the ad set level. This metric is estimated.
result_rateARRAYThe percentage of results you received out of all the views of your ads.
resultsARRAYThe number of results you received out of all the views of your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
Ad Insights by Age and Gender 102 fields · facebook_ads_ad_account_insights_by_age_and_gender
Facebook Ads Ad Insights by Age and Gender fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
ageSTRINGThe age range of the people who saw your ad. This is based on the age people have listed in their Facebook profiles.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
genderSTRINGThe gender of the people who saw your ad. This is based on the gender people have listed in their Facebook profiles.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Campaign 89 fields · facebook_ads_ad_account_insights_by_campaign
Facebook Ads Ad Insights by Campaign fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe number of people who saw your ads at least once, deduplicated at the campaign level. This metric is estimated.
result_rateARRAYThe percentage of results you received out of all the views of your ads.
resultsARRAYThe number of results you received out of all the views of your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
Ad Insights by Country 101 fields · facebook_ads_ad_account_insights_by_country
Facebook Ads Ad Insights by Country fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
countrySTRINGThe country where the people you've reached are located. This is based on information, such as a person's hometown, their current city, and the geographical location where they tend to be when they visit Meta.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Device Platform 101 fields · facebook_ads_ad_account_insights_by_device_platform
Facebook Ads Ad Insights by Device Platform fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
device_platformSTRINGdevice_platform
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Link URL Asset 101 fields · facebook_ads_ad_account_insights_by_link_url_asset
Facebook Ads Ad Insights by Link URL Asset fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
link_url_assetOBJECTThe ID of the URL asset involved in impression, click or action.
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Product ID 101 fields · facebook_ads_ad_account_insights_by_product_id
Facebook Ads Ad Insights by Product ID fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
product_idSTRINGThe ID of the product associated with the ad.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Publisher Platform and Position 102 fields · facebook_ads_ad_account_insights_by_publisher_platform_and_position
Facebook Ads Ad Insights by Publisher Platform and Position fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
platform_positionSTRINGplatform_position
publisher_platformSTRINGWhich platform your ad was shown, for example on Facebook, Instagram, or Audience Network.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ad Insights by Region 101 fields · facebook_ads_ad_account_insights_by_region
Facebook Ads Ad Insights by Region fields
FieldTypeDescription
account_currencySTRINGCurrency that is used by your ad account.
account_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesARRAYThe total value of all conversions attributed to your ads.
actionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsARRAYad_click_actions
ad_idSTRINGThe unique ID of the ad you're viewing in reporting.
ad_impression_actionsARRAYad_impression_actions
ad_nameSTRINGThe name of the ad you're viewing in reporting.
adset_idSTRINGThe 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_nameSTRINGThe 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.
attribution_settingSTRINGThe default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
auction_bidNUMBERauction_bid
auction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typeSTRINGThe method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.
campaign_idSTRINGThe unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
campaign_nameSTRINGThe name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentNUMBERThe average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
canvas_avg_view_timeNUMBERThe average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.
catalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksNUMBERThe number of clicks on your ads.
conversion_valuesARRAYconversion_values
conversionsARRAYconversions
converted_product_quantityARRAYThe number of products purchased which are recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
converted_product_valueARRAYThe value of purchases recorded by your merchant partner's pixel or app SDK for a given product ID and driven by your ads. Has to be used together with converted product ID breakdown.
cost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpcNUMBERThe average cost for each click (all).
cpmNUMBERThe average cost for 1,000 impressions.
cppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timeSTRINGcreated_time
ctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startDATEThe start date for your data. This is controlled by the date range you've selected for your reporting view.
date_stopDATEThe end date for your data. This is controlled by the date range you've selected for your reporting view.
dda_countby_convsNUMBERdda_countby_convs
dda_resultsARRAYdda_results
frequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsNUMBERThe number of Full Views on your Page's posts as a result of your ad.
full_view_reachNUMBERThe number of people who performed a Full View on your Page's post as a result of your ad.
impressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksNUMBERThe 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_engagementNUMBERThe total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.
instagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_rateNUMBERThe 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.
mobile_app_purchase_roasARRAYThe 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.
objectiveSTRINGThe objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases.
optimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roasARRAYThe total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads.
qualifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachNUMBERThe 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.
regionSTRINGThe region where your ads were shown.
result_rateARRAYThe result rate from your ads.
resultsARRAYThe number of results from your ads.
shops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendNUMBERThe total amount you've spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendNUMBERThe estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeSTRINGupdated_time
video_30_sec_watched_actionsARRAYThe number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
video_avg_time_watched_actionsARRAYThe average time a video was played, including any time spent replaying the video for a single impression.
video_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsARRAYThe number of times your video was played at 100% of its length, including plays that skipped to this point.
video_p25_watched_actionsARRAYThe number of times your video was played at 25% of its length, including plays that skipped to this point.
video_p50_watched_actionsARRAYThe number of times your video was played at 50% of its length, including plays that skipped to this point.
video_p75_watched_actionsARRAYThe number of times your video was played at 75% of its length, including plays that skipped to this point.
video_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsARRAYThe number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.
video_play_curve_actionsARRAYA video-play based curve graph that illustrates the percentage of video plays that reached a given second. Entries 0 to 14 represent seconds 0 thru 14. Entries 15 to 17 represent second ranges \[15 to 20), \[20 to 25), and \[25 to 30). Entries 18 to 20 represent second ranges \[30 to 40), \[40 to 50), and \[50 to 60). Entry 21 represents plays over 60 seconds.
video_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roasARRAYThe 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.
wish_bidNUMBERwish_bid
Ads 24 fields · facebook_ads_ad_account_ads
Facebook Ads Ads fields
FieldTypeDescription
idSTRINGThe ID of this ad
account_idSTRINGThe ID of the ad account that this ad belongs to
ad_active_timeSTRINGThe time from when the ad was recently active
ad_schedule_end_timeDATETIMEAn optional parameter that defines the end time of an individual ad. If no end time is defined, the ad will run on the campaign's schedule
ad_schedule_start_timeDATETIMEAn optional parameter that defines the start time of an individual ad. If no start time is defined, the ad will run on the campaign's schedule
adlabelsARRAYAd labels associated with this ad
adset_idSTRINGID of the ad set that contains the ad
bid_amountINTEGERBid amount for this ad which will be used in auction
campaign_idSTRINGID of the ad campaign that contains this ad
configured_statusSTRINGThe configured status of the ad. Use status instead of this field
conversion_domainSTRINGThe domain where conversions happen
created_timeDATETIMETime when the ad was created
creative_idSTRINGUnique ID for the ad creative
creative_effective_object_story_idSTRINGThe ID of a page post to use in an ad
creative_nameSTRINGName of the ad creative
creative_url_tagsSTRINGQuery string parameters appended to urls clicked from page post ads
effective_statusSTRINGThe effective status of the ad
issues_infoARRAYIssues for this ad that prevented it from delivering
last_updated_by_app_idSTRINGIndicates the app used for the most recent update of the ad
nameSTRINGName of the ad
preview_shareable_linkSTRINGA link that enables users to preview ads in different placements
source_ad_idSTRINGThe source ad id that this ad is copied from
statusSTRINGThe configured status of the ad
updated_timeDATETIMETime when this ad was updated

Trust

Data Partner You Can Trust

users

175K

Executives and data analysts across 20+ industries

G2 rating

4.9★

“A trusted data analytics partner” — verified review

npm installs

156K

In Open Source We Trust

Customers

What users are saying

Every claim has a receipt.

Real things real customers said — each quote pinned to a specific claim, straight from the quotes database.

A3re: trusting AI
Nodari RizunNodari RizunFounder & CEO, Pürblack®
“AI, by the nature of the models, will hallucinate. And because of that, you need something which will create guardrails to ensure that there are no hallucinations, that you can trust your data.”
C9re: one source of truth
Mark SimmonsMark SimmonsCMO, Pürblack®
“We had six or seven different channels and no single source of truth — it was almost impossible, a lot of guesswork.”
E7re: getting time back
Nodari RizunNodari RizunFounder & CEO, Pürblack®
“We regained time. And time is the one resource that never comes back.”

Turn your Facebook Ads Connector to Microsoft Excel data into business decisions

Get started free