Skip to content

Facebook Marketing Supported Endpoints and Fields

This page lists the Facebook Marketing endpoints and fields in the Facebook Ads connector.

Use it to choose an endpoint and fields.

Each endpoint lists its destination table, unique keys, and Meta reference.

OWOX requests Meta Graph API version v25.0.

  • For performance reporting such as spend, impressions, clicks, reach, conversions, and ROAS, start with Ad Account Insights.
  • For reporting split by audience, placement, geography, product, or URL asset, use one of the Ad Account Insights by … breakdown endpoints.
  • For performance aggregated at the ad set or campaign level, use Ad Insights by Ad Set or Ad Insights by Campaign. These endpoints deduplicate reach to match Meta Ads Manager.
  • For ad account metadata, use Ad Account.
  • For ad names, statuses, campaign IDs, ad set IDs, and creative IDs, use Ad Account Ads.
  • For creative metadata such as body text, image URL, object story ID, URL tags, or thumbnails, use Ad Account Ad Creatives.
  • For users assigned to the ad account, use Ad Account User.
EndpointUse it forFieldsUnique keysDefault destination tableMeta reference
Ad Account User (ad-account-user)Users assigned to the ad account.2idfacebook_ads_ad_account_userAd Account User
Ad Account (ad-account)Ad account settings, billing, status, timezone, currency, and business metadata.61id, account_idfacebook_ads_ad_accountAd Account
Ad Account Ad Creatives (ad-account/adcreatives)Creative metadata such as body text, images, object story IDs, URL tags, and thumbnails.63idfacebook_ads_ad_account_adcreativesAd Account Ad Creatives
Ad Account Ads (ad-account/ads)Ad metadata such as name, status, campaign ID, ad set ID, creative ID, and update time.24idfacebook_ads_ad_account_adsAd Account Ads
Ad Account Insights (ad-account/insights)Daily ad-level performance metrics without an additional breakdown.100ad_id, date_start, date_stopfacebook_ads_ad_account_insightsAd Account Insights
Ad Account Insights by Age and Gender (ad-account/insights-by-age-and-gender)Daily ad-level performance split by audience age and gender.102ad_id, date_start, date_stop, age, genderfacebook_ads_ad_account_insights_by_age_and_genderAd Account Insights
Ad Account Insights by Country (ad-account/insights-by-country)Daily ad-level performance split by country.101ad_id, date_start, date_stop, countryfacebook_ads_ad_account_insights_by_countryAd Account Insights
Ad Account Insights by Device Platform (ad-account/insights-by-device-platform)Daily ad-level performance split by device platform.101ad_id, date_start, date_stop, device_platformfacebook_ads_ad_account_insights_by_device_platformAd Account Insights
Ad Account Insights by Link URL Asset (ad-account/insights-by-link-url-asset)Daily ad-level performance split by link URL asset.101ad_id, date_start, date_stopfacebook_ads_ad_account_insights_by_link_url_assetAd Account Insights
Ad Account Insights by Product ID (ad-account/insights-by-product-id)Daily ad-level performance split by product ID.101ad_id, date_start, date_stop, product_idfacebook_ads_ad_account_insights_by_product_idAd Account Insights
Ad Account Insights by Publisher Platform and Position (ad-account/insights-by-publisher-platform-and-position)Daily ad-level performance split by Meta platform and placement position.102ad_id, date_start, date_stop, publisher_platform, platform_positionfacebook_ads_ad_account_insights_by_publisher_platform_and_positionAd Account Insights
Ad Account Insights by Region (ad-account/insights-by-region)Daily ad-level performance split by region.101ad_id, date_start, date_stop, regionfacebook_ads_ad_account_insights_by_regionAd Account Insights
Ad Insights by Ad Set (ad-account/insights-by-adset)Daily ad set-level performance with reach deduplicated to match Meta Ads Manager.92adset_id, date_start, date_stopfacebook_ads_ad_account_insights_by_adsetAd Account Insights
Ad Insights by Campaign (ad-account/insights-by-campaign)Daily campaign-level performance with reach deduplicated to match Meta Ads Manager.89campaign_id, date_start, date_stopfacebook_ads_ad_account_insights_by_campaignAd Account Insights
Ad Object (formerly Ad Group) (ad-group)Legacy ad object fields. Prefer Ad Account Ads unless you specifically need fields listed only in this endpoint.32idfacebook_ads_ad_groupAd Group
  • Connector field shows the field name in OWOX.
  • OWOX writes the connector field to the destination table.
  • Meta API field shows the field expression that OWOX requests from Meta.
  • Nested fields use expressions such as creative.id.
  • Data type shows the type that OWOX uses in the destination schema.
  • OWOX uses Unique keys to match rows during loading.
  • OWOX adds these unique keys to every request automatically.
  • You do not need to select them as fields.
  • Insights endpoints return daily rows at the ad, ad set, or campaign level.
  • Breakdown endpoints add the listed breakdown fields.

Official Meta reference: Ad Account User

Connector fieldMeta API fieldData typeDescription
ididSTRINGID of the App Scoped User
namenameSTRINGUser public full name

Official Meta reference: Ad Account

Connector fieldMeta API fieldData typeDescription
ididSTRINGThe string act_{ad_account_id}.
account_idaccount_idSTRINGThe ID of the Ad Account.
account_statusaccount_statusINTEGERStatus of the account:
ageageNUMBERAmount of time the ad account has been open, in days.
agency_client_declarationagency_client_declarationSTRINGDetails of the agency advertising on behalf of this client account, if applicable. Requires Business Manager Admin privileges.
amount_spentamount_spentSTRINGCurrent amount spent by the account with respect to spend_cap. Or total amount in the absence of spend_cap.
attribution_specattribution_specARRAYDeprecated due to iOS 14 changes. Please visit the changelog for more information.
balancebalanceSTRINGBill amount due for this Ad Account.
brand_safety_content_filter_levelsbrand_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.
businessbusinessSTRINGThe Business Manager, if this ad account is owned by one
business_citybusiness_citySTRINGCity for business address
business_country_codebusiness_country_codeSTRINGCountry code for the business address
business_namebusiness_nameSTRINGThe business name for the account
business_statebusiness_stateSTRINGState abbreviation for business address
business_streetbusiness_streetSTRINGFirst line of the business street address for the account
business_street2business_street2STRINGSecond line of the business street address for the account
business_zipbusiness_zipSTRINGZip code for business address
can_create_brand_lift_studycan_create_brand_lift_studyBOOLEANIf we can create a new automated brand lift study under the Ad Account.
capabilitiescapabilitiesARRAYList of capabilities an Ad Account can have. See capabilities
created_timecreated_timeDATETIMEThe time the account was created in ISO 8601 format.
currencycurrencySTRINGThe currency used for the account, based on the corresponding value in the account settings. See supported currencies
default_dsa_beneficiarydefault_dsa_beneficiarySTRINGThis is the default value for creating L2 object of dsa_beneficiary
default_dsa_payordefault_dsa_payorSTRINGThis is the default value for creating L2 object of dsa_payor
disable_reasondisable_reasonINTEGERThe reason why the account was disabled. Possible reasons are:
end_advertiserend_advertiserSTRINGThe entity the ads will target. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID.
end_advertiser_nameend_advertiser_nameSTRINGThe name of the entity the ads will target.
existing_customersexisting_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_detailsexpired_funding_source_detailsSTRINGID = ID of the payment method
extended_credit_invoice_groupextended_credit_invoice_groupSTRINGThe extended credit invoice group that the ad account belongs to
failed_delivery_checksfailed_delivery_checksARRAYFailed delivery checks
fb_entityfb_entityINTEGERfb_entity
funding_sourcefunding_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_detailsfunding_source_detailsSTRINGID = ID of the payment method
has_migrated_permissionshas_migrated_permissionsBOOLEANWhether this account has migrated permissions
io_numberio_numberSTRINGThe Insertion Order (IO) number.
is_attribution_spec_system_defaultis_attribution_spec_system_defaultBOOLEANIf the attribution specification of ad account is generated from system default values
is_direct_deals_enabledis_direct_deals_enabledBOOLEANWhether the account is enabled to run Direct Deals
is_in_3ds_authorization_enabled_marketis_in_3ds_authorization_enabled_marketBOOLEANIf the account is in a market requiring to go through payment process going through 3DS authorization
is_notifications_enabledis_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_personalis_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_accountis_prepay_accountBOOLEANIf this ad account is a prepay. Other option would be a postpay account.
is_tax_id_requiredis_tax_id_requiredBOOLEANIf tax id for this ad account is required or not.
line_numbersline_numbersARRAYThe line numbers
media_agencymedia_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_capmin_campaign_group_spend_capSTRINGThe minimum required spend cap of Ad Campaign.
min_daily_budgetmin_daily_budgetINTEGERThe minimum daily budget for this Ad Account
namenameSTRINGName of the account. If not set, the name of the first admin visible to the user will be returned.
offsite_pixels_tos_acceptedoffsite_pixels_tos_acceptedBOOLEANIndicates whether the offsite pixel Terms Of Service contract was signed. This feature can be accessible before v2.9
ownerownerSTRINGThe ID of the account owner
partnerpartnerSTRINGThis 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_specrf_specOBJECTReach and Frequency limits configuration. See Reach and Frequency
spend_capspend_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_idtax_idSTRINGTax ID
tax_id_statustax_id_statusINTEGERVAT status code for the account.
tax_id_typetax_id_typeSTRINGType of Tax ID
timezone_idtimezone_idINTEGERThe timezone ID of this ad account
timezone_nametimezone_nameSTRINGName for the time zone
timezone_offset_hours_utctimezone_offset_hours_utcNUMBERTime zone difference from UTC (Coordinated Universal Time).
tos_acceptedtos_acceptedOBJECTChecks if this specific ad account has signed the Terms of Service contracts. Returns 1, if terms were accepted.
user_tasksuser_tasksARRAYuser_tasks
user_tos_accepteduser_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 Ad Creatives (ad-account/adcreatives)

Section titled “Ad Account Ad Creatives (ad-account/adcreatives)”

Official Meta reference: Ad Account Ad Creatives

Connector fieldMeta API fieldData typeDescription
ididSTRINGUnique ID for an ad creative, numeric string.
account_idaccount_idSTRINGAd account ID for the account this ad creative belongs to.
actor_idactor_idSTRINGThe actor ID (Page ID or User ID) of this creative
ad_disclaimer_specad_disclaimer_specSTRINGAd disclaimer data on creative for additional information on ads.
adlabelsadlabelsARRAYAd Labels associated with this creative. Used to group it with related ad objects.
applink_treatmentapplink_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_specasset_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_categoryauthorization_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.
bodybodySTRINGThe body of the ad. Not supported for video post creatives
branded_contentbranded_contentSTRINGbranded_content
branded_content_sponsor_page_idbranded_content_sponsor_page_idSTRINGID for page representing business which runs Branded Content ads. See Creating Branded Content Ads.
bundle_folder_idbundle_folder_idSTRINGThe Dynamic Ad’s bundle folder ID
call_to_action_typecall_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_criteriacategorization_criteriaSTRINGThe Dynamic Category Ad’s categorization field, e.g. brand
category_media_sourcecategory_media_sourceSTRINGThe Dynamic Ad’s rendering mode for category ads
collaborative_ads_lsb_image_bank_idcollaborative_ads_lsb_image_bank_idSTRINGUsed for CPAS local delivery image bank
contextual_multi_adscontextual_multi_adsSTRINGcontextual_multi_ads
creative_sourcing_speccreative_sourcing_specSTRINGcreative_sourcing_spec
degrees_of_freedom_specdegrees_of_freedom_specSTRINGSpecifies the types of transformations that are enabled for the given creative
destination_set_iddestination_set_idSTRINGThe ID of the Product Set for a Destination Catalog that will be used to link with Travel Catalogs
dynamic_ad_voicedynamic_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_categoryeffective_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_ideffective_instagram_media_idSTRINGThe ID of an Instagram post to use in an ad
effective_object_story_ideffective_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_installenable_direct_installBOOLEANWhether Direct Install should be enabled on supported devices
enable_launch_instant_appenable_launch_instant_appBOOLEANWhether Instant App should be enabled on supported devices
facebook_branded_contentfacebook_branded_contentSTRINGStores fields for Facebook Branded Content
image_cropsimage_cropsSTRINGA JSON object defining crop dimensions for the image specified. See image crop reference for more details
image_hashimage_hashSTRINGImage hash for ad creative. If provided, do not add image_url. See image library for more details.
image_urlimage_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_urlinstagram_permalink_urlSTRINGURL for a post on Instagram you want to run as an ad. Also known as Instagram media.
instagram_user_idinstagram_user_idSTRINGInstagram actor ID
interactive_components_specinteractive_components_specSTRINGSpecification for all the interactive components that would show up on the ad
link_destination_display_urllink_destination_display_urlSTRINGOverwrites the display URL for link ads when object_url is set to a click tag
link_og_idlink_og_idSTRINGThe Open Graph (OG) ID for the link in this creative if the landing page has OG tags
link_urllink_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_messagemessenger_sponsored_messageSTRINGUsed for Messenger sponsored message. JSON string with message for this ad creative. See Messenger Platform, Send API Reference.
namenameSTRINGName of this ad creative as seen in the ad account’s library. This field has a limit of 100 characters.
object_idobject_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_urlobject_store_urlSTRINGiTunes or Google Play of the destination of an app ad
object_story_idobject_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_specobject_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_typeobject_typeSTRINGThe type of Facebook object you want to advertise. Allowed values are:
object_urlobject_urlSTRINGURL that opens if someone clicks your link on a link ad. This URL is not connected to a Facebook page.
page_welcome_messagepage_welcome_messageSTRINGPage welcome message for CTM ads
photo_album_source_object_story_idphoto_album_source_object_story_idSTRINGphoto_album_source_object_story_id
place_page_set_idplace_page_set_idSTRINGThe ID of the page set for this creative. See theLocal Awareness guide
platform_customizationsplatform_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_idplayable_asset_idSTRINGThe ID of the playable asset in this creative
portrait_customizationsportrait_customizationsSTRINGThis field describes the rendering customizations selected for portrait mode ads like IG Stories, FB Stories, IGTV, etc
product_dataproduct_dataARRAYproduct_data
product_set_idproduct_set_idSTRINGUsed for Dynamic Ad. An ID for a product set, which groups related products or other items being advertised.
recommender_settingsrecommender_settingsSTRINGUsed for Dynamic Ads. Settings to display Dynamic ads based on product recommendations.
source_instagram_media_idsource_instagram_media_idSTRINGThe ID of an Instagram post for creating ads
statusstatusSTRINGThe status of the creative. WITH_ISSUES and IN_PROCESS are available for 4.0 or higher
template_urltemplate_urlSTRINGUsed for Dynamic Ads when you want to use third-party click tracking. See Dynamic Ads, Click Tracking and Templates.
template_url_spectemplate_url_specSTRINGUsed for Dynamic Ads when you want to use third-party click tracking. See Dynamic Ads, Click Tracking and Templates.
thumbnail_idthumbnail_idSTRINGthumbnail_id
thumbnail_urlthumbnail_urlSTRINGURL for a thumbnail image for this ad creative. You can provide dimensions for this with thumbnail_width and thumbnail_height. See example.
titletitleSTRINGTitle for link ad, which does not belong to a page.
url_tagsurl_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_overrideuse_page_actor_overrideBOOLEANUsed for App Ads. If true, we display the Facebook page associated with the app ads.
video_idvideo_idSTRING

Official Meta reference: Ad Account Ads

Connector fieldMeta API fieldData typeDescription
ididSTRINGThe ID of this ad
account_idaccount_idSTRINGThe ID of the ad account that this ad belongs to
ad_active_timead_active_timeSTRINGThe time from when the ad was recently active
ad_schedule_end_timead_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_timead_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
adlabelsadlabelsARRAYAd labels associated with this ad
adset_idadset_idSTRINGID of the ad set that contains the ad
bid_amountbid_amountINTEGERBid amount for this ad which will be used in auction
campaign_idcampaign_idSTRINGID of the ad campaign that contains this ad
configured_statusconfigured_statusSTRINGThe configured status of the ad. Use status instead of this field
conversion_domainconversion_domainSTRINGThe domain where conversions happen
created_timecreated_timeDATETIMETime when the ad was created
creative_idcreative.idSTRINGUnique ID for the ad creative
creative_effective_object_story_idcreative.effective_object_story_idSTRINGThe ID of a page post to use in an ad
creative_namecreative.nameSTRINGName of the ad creative
creative_url_tagscreative.url_tagsSTRINGQuery string parameters appended to urls clicked from page post ads
effective_statuseffective_statusSTRINGThe effective status of the ad
issues_infoissues_infoARRAYIssues for this ad that prevented it from delivering
last_updated_by_app_idlast_updated_by_app_idSTRINGIndicates the app used for the most recent update of the ad
namenameSTRINGName of the ad
preview_shareable_linkpreview_shareable_linkSTRINGA link that enables users to preview ads in different placements
source_ad_idsource_ad_idSTRINGThe source ad id that this ad is copied from
statusstatusSTRINGThe configured status of the ad
updated_timeupdated_timeDATETIMETime when this ad was updated

Official Meta reference: Ad Group

Connector fieldMeta API fieldData typeDescription
ididSTRINGThe ID of this ad.
account_idaccount_idSTRINGThe ID of the ad account that this ad belongs to.
ad_active_timead_active_timeSTRINGThe time from when the ad was recently active
ad_review_feedbackad_review_feedbackOBJECTThe review feedback for this ad after it is reviewed.
ad_schedule_end_timead_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_timead_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.
adlabelsadlabelsARRAYAd labels associated with this ad
adsetadsetOBJECTAd set that contains this ad
adset_idadset_idSTRINGID of the ad set that contains the ad
bid_amountbid_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.
campaigncampaignOBJECTAd campaign that contains this ad
campaign_idcampaign_idSTRINGID of the ad campaign that contains this ad
configured_statusconfigured_statusSTRINGThe configured status of the ad. Use status instead of this field.
conversion_domainconversion_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_timecreated_timeDATETIMETime when the ad was created.
creative_idcreative.idSTRINGUnique ID for the ad creative
creative_effective_object_story_idcreative.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_namecreative.nameSTRINGName of the ad creative as seen in the ad accounts library
creative_object_story_speccreative.object_story_specSTRINGObject story spec containing page_id and other details
creative_url_tagscreative.url_tagsSTRINGA set of query string parameters which will replace or be appended to urls clicked from page post ads
creative_asset_groups_speccreative_asset_groups_specOBJECTThis field is used to create ads using the Flexible ad format. You can read more about that here
effective_statuseffective_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_infoissues_infoARRAYIssues for this ad that prevented it from delivering
last_updated_by_app_idlast_updated_by_app_idSTRINGIndicates the app used for the most recent update of the ad.
namenameSTRINGName of the ad.
preview_shareable_linkpreview_shareable_linkSTRINGA link that enables users to preview ads in different placements
recommendationsrecommendationsARRAYIf 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_adsource_adOBJECTThe source ad that this ad is copied from
source_ad_idsource_ad_idSTRINGThe source ad id that this ad is copied from
statusstatusSTRINGThe configured status of the ad. The field returns the same value as configured_status. Use this field, instead of configured_status.
tracking_specstracking_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_timeupdated_timeDATETIMETime when this ad was updated.

Insights endpoints return daily performance data. Ad Account Insights and its breakdown endpoints report at the ad level. Choose a breakdown endpoint when you need the same metrics split by audience, geography, device, URL asset, product, platform, or region. Ad Insights by Ad Set and Ad Insights by Campaign report at those higher levels instead, and deduplicate reach to match Meta Ads Manager.

EndpointAdds breakdown byExtra fieldsUnique keysDefault destination tableMeta reference
Ad Account Insights (ad-account/insights)NoneNonead_id, date_start, date_stopfacebook_ads_ad_account_insightsAd Account Insights
Ad Account Insights by Age and Gender (ad-account/insights-by-age-and-gender)Age and genderage, genderad_id, date_start, date_stop, age, genderfacebook_ads_ad_account_insights_by_age_and_genderAd Account Insights
Ad Account Insights by Country (ad-account/insights-by-country)Countrycountryad_id, date_start, date_stop, countryfacebook_ads_ad_account_insights_by_countryAd Account Insights
Ad Account Insights by Device Platform (ad-account/insights-by-device-platform)Device platformdevice_platformad_id, date_start, date_stop, device_platformfacebook_ads_ad_account_insights_by_device_platformAd Account Insights
Ad Account Insights by Link URL Asset (ad-account/insights-by-link-url-asset)Link URL assetlink_url_assetad_id, date_start, date_stopfacebook_ads_ad_account_insights_by_link_url_assetAd Account Insights
Ad Account Insights by Product ID (ad-account/insights-by-product-id)Product IDproduct_idad_id, date_start, date_stop, product_idfacebook_ads_ad_account_insights_by_product_idAd Account Insights
Ad Account Insights by Publisher Platform and Position (ad-account/insights-by-publisher-platform-and-position)Publisher platform and placement positionplatform_position, publisher_platformad_id, date_start, date_stop, publisher_platform, platform_positionfacebook_ads_ad_account_insights_by_publisher_platform_and_positionAd Account Insights
Ad Account Insights by Region (ad-account/insights-by-region)Regionregionad_id, date_start, date_stop, regionfacebook_ads_ad_account_insights_by_regionAd Account Insights
Ad Insights by Ad Set (ad-account/insights-by-adset)None — ad set levelNoneadset_id, date_start, date_stopfacebook_ads_ad_account_insights_by_adsetAd Account Insights
Ad Insights by Campaign (ad-account/insights-by-campaign)None — campaign levelNonecampaign_id, date_start, date_stopfacebook_ads_ad_account_insights_by_campaignAd Account Insights

Use these fields with ad-account/insights and every ad-account/insights-by-* endpoint.

Ad Insights by Ad Set and Ad Insights by Campaign use a subset of these fields. Some ad-level fields do not apply at the ad set or campaign level.

Official Meta reference: Ad Account Insights

Connector fieldMeta API fieldData typeDescription
account_currencyaccount_currencySTRINGCurrency that is used by your ad account.
account_idaccount_idSTRINGThe ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
account_nameaccount_nameSTRINGThe name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.
action_valuesaction_valuesARRAYThe total value of all conversions attributed to your ads.
actionsactionsARRAYThe total number of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.
ad_click_actionsad_click_actionsARRAYad_click_actions
ad_idad_idSTRINGThe unique ID of the ad you’re viewing in reporting.
ad_impression_actionsad_impression_actionsARRAYad_impression_actions
ad_namead_nameSTRINGThe name of the ad you’re viewing in reporting.
adset_idadset_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_nameadset_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_settingattribution_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_bidauction_bidNUMBERauction_bid
auction_competitivenessauction_competitivenessNUMBERauction_competitiveness
auction_max_competitor_bidauction_max_competitor_bidNUMBERauction_max_competitor_bid
buying_typebuying_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_idcampaign_idSTRINGThe unique ID number of the ad campaign you’re viewing in reporting. Your campaign contains ad sets and ads.
campaign_namecampaign_nameSTRINGThe name of the ad campaign you’re viewing in reporting. Your campaign contains ad sets and ads.
canvas_avg_view_percentcanvas_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_timecanvas_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_actionscatalog_segment_actionsARRAYThe number of actions performed attributed to your ads promoting your catalog segment, broken down by action type.
catalog_segment_valuecatalog_segment_valueARRAYThe total value of all conversions from your catalog segment attributed to your ads.
catalog_segment_value_mobile_purchase_roascatalog_segment_value_mobile_purchase_roasARRAYThe total return on ad spend (ROAS) from mobile app purchases for your catalog segment.
catalog_segment_value_omni_purchase_roascatalog_segment_value_omni_purchase_roasARRAYThe total return on ad spend (ROAS) from all purchases for your catalog segment.
catalog_segment_value_website_purchase_roascatalog_segment_value_website_purchase_roasARRAYThe total return on ad spend (ROAS) from website purchases for your catalog segment.
clicksclicksNUMBERThe number of clicks on your ads.
conversion_valuesconversion_valuesARRAYconversion_values
conversionsconversionsARRAYconversions
converted_product_quantityconverted_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_valueconverted_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_viewcost_per_15_sec_video_viewARRAYcost_per_15_sec_video_view
cost_per_2_sec_continuous_video_viewcost_per_2_sec_continuous_video_viewARRAYcost_per_2_sec_continuous_video_view
cost_per_action_typecost_per_action_typeARRAYThe average cost of a relevant action.
cost_per_ad_clickcost_per_ad_clickARRAYcost_per_ad_click
cost_per_conversioncost_per_conversionARRAYcost_per_conversion
cost_per_dda_countby_convscost_per_dda_countby_convsNUMBERcost_per_dda_countby_convs
cost_per_inline_link_clickcost_per_inline_link_clickNUMBERThe average cost of each inline link click.
cost_per_inline_post_engagementcost_per_inline_post_engagementNUMBERThe average cost of each inline post engagement.
cost_per_one_thousand_ad_impressioncost_per_one_thousand_ad_impressionARRAYcost_per_one_thousand_ad_impression
cost_per_outbound_clickcost_per_outbound_clickARRAYThe average cost for each outbound click.
cost_per_resultcost_per_resultARRAYThe average cost per result from your ads.
cost_per_thruplaycost_per_thruplayARRAYThe average cost for each ThruPlay. This metric is in development.
cost_per_unique_action_typecost_per_unique_action_typeARRAYThe average cost of each unique action. This metric is estimated.
cost_per_unique_clickcost_per_unique_clickNUMBERThe average cost for each unique click (all). This metric is estimated.
cost_per_unique_conversioncost_per_unique_conversionARRAYcost_per_unique_conversion
cost_per_unique_inline_link_clickcost_per_unique_inline_link_clickNUMBERThe average cost of each unique inline link click. This metric is estimated.
cost_per_unique_outbound_clickcost_per_unique_outbound_clickARRAYThe average cost for each unique outbound click. This metric is estimated.
cpccpcNUMBERThe average cost for each click (all).
cpmcpmNUMBERThe average cost for 1,000 impressions.
cppcppNUMBERThe average cost to reach 1,000 people. This metric is estimated.
created_timecreated_timeSTRINGcreated_time
ctrctrNUMBERThe percentage of times people saw your ad and performed a click (all).
date_startdate_startDATEThe start date for your data. This is controlled by the date range you’ve selected for your reporting view.
date_stopdate_stopDATEThe end date for your data. This is controlled by the date range you’ve selected for your reporting view.
dda_countby_convsdda_countby_convsNUMBERdda_countby_convs
dda_resultsdda_resultsARRAYdda_results
frequencyfrequencyNUMBERThe average number of times each person saw your ad. This metric is estimated.
full_view_impressionsfull_view_impressionsNUMBERThe number of Full Views on your Page’s posts as a result of your ad.
full_view_reachfull_view_reachNUMBERThe number of people who performed a Full View on your Page’s post as a result of your ad.
impressionsimpressionsNUMBERThe number of times your ads were on screen.
inline_link_click_ctrinline_link_click_ctrNUMBERThe percentage of time people saw your ads and performed an inline link click.
inline_link_clicksinline_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_engagementinline_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_setinstagram_upcoming_event_reminders_setNUMBERinstagram_upcoming_event_reminders_set
instant_experience_clicks_to_openinstant_experience_clicks_to_openNUMBERinstant_experience_clicks_to_open
instant_experience_clicks_to_startinstant_experience_clicks_to_startNUMBERinstant_experience_clicks_to_start
instant_experience_outbound_clicksinstant_experience_outbound_clicksARRAYinstant_experience_outbound_clicks
interactive_component_tapinteractive_component_tapARRAYinteractive_component_tap
marketing_messages_delivery_ratemarketing_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_roasmobile_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.
objectiveobjectiveSTRINGThe 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_goaloptimization_goalSTRINGThe optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.
outbound_clicksoutbound_clicksARRAYThe number of clicks on links that take people off Facebook-owned properties.
outbound_clicks_ctroutbound_clicks_ctrARRAYThe percentage of times people saw your ad and performed an outbound click.
purchase_roaspurchase_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_ratequalifying_question_qualify_answer_rateNUMBERqualifying_question_qualify_answer_rate
reachreachNUMBERThe 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_rateresult_rateARRAYThe percentage of results you received out of all the views of your ads.
resultsresultsARRAYThe number of results you received out of all the views of your ads.
shops_assisted_purchasesshops_assisted_purchasesSTRINGshops_assisted_purchases
social_spendsocial_spendNUMBERThe total amount you’ve spent so far for your ads showed with social information. (ex: Jane Doe likes this).
spendspendNUMBERThe estimated total amount of money you’ve spent on your campaign, ad set or ad during its schedule. This metric is estimated.
updated_timeupdated_timeSTRINGupdated_time
video_30_sec_watched_actionsvideo_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_actionsvideo_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_actionsvideo_continuous_2_sec_watched_actionsARRAYvideo_continuous_2_sec_watched_actions
video_p100_watched_actionsvideo_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_actionsvideo_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_actionsvideo_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_actionsvideo_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_actionsvideo_p95_watched_actionsARRAYThe number of times your video was played at 95% of its length, including plays that skipped to this point.
video_play_actionsvideo_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_actionsvideo_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_actionsvideo_play_retention_0_to_15s_actionsARRAYvideo_play_retention_0_to_15s_actions
video_play_retention_20_to_60s_actionsvideo_play_retention_20_to_60s_actionsARRAYvideo_play_retention_20_to_60s_actions
video_play_retention_graph_actionsvideo_play_retention_graph_actionsARRAYvideo_play_retention_graph_actions
video_time_watched_actionsvideo_time_watched_actionsARRAYvideo_time_watched_actions
website_ctrwebsite_ctrARRAYThe percentage of times people saw your ad and performed a link click.
website_purchase_roaswebsite_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_bidwish_bidNUMBERwish_bid
EndpointAdditional connector fieldMeta API fieldData typeDescription
Ad Account Insights by Age and Gender (ad-account/insights-by-age-and-gender)ageageSTRINGThe age range of the people who saw your ad. This is based on the age people have listed in their Facebook profiles.
Ad Account Insights by Age and Gender (ad-account/insights-by-age-and-gender)gendergenderSTRINGThe gender of the people who saw your ad. This is based on the gender people have listed in their Facebook profiles.
Ad Account Insights by Country (ad-account/insights-by-country)countrycountrySTRINGThe 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.
Ad Account Insights by Device Platform (ad-account/insights-by-device-platform)device_platformdevice_platformSTRINGThe device platform where your ad was shown, such as desktop or mobile.
Ad Account Insights by Link URL Asset (ad-account/insights-by-link-url-asset)link_url_assetlink_url_assetOBJECTThe ID of the URL asset involved in impression, click, or action.
Ad Account Insights by Product ID (ad-account/insights-by-product-id)product_idproduct_idSTRINGThe ID of the product associated with the ad.
Ad Account Insights by Publisher Platform and Position (ad-account/insights-by-publisher-platform-and-position)platform_positionplatform_positionSTRINGThe placement position where your ad was shown.
Ad Account Insights by Publisher Platform and Position (ad-account/insights-by-publisher-platform-and-position)publisher_platformpublisher_platformSTRINGWhich platform your ad was shown, for example Facebook, Instagram, or Audience Network.
Ad Account Insights by Region (ad-account/insights-by-region)regionregionSTRINGThe region where your ads were shown.