Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Snapchat: Most-used fields

The table below gives information about most-used fields that you can import from Snapchat. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

FieldAdverity UI nameType
GendergenderDimension

The gender of the audience targeted in Snapchat ads.

ad_account_idDimension

The unique identifier for the ad account.

ad_account_nameDimension

The name of the ad account.

ad_idDimension

The unique identifier for an individual ad.

ad_nameDimension

The name of the ad.

ad_productDimension

The specific ad product used for the creative (e.g., Story Ad, Collection Ad).

ad_scheduling_configDimension

Configuration settings that dictate the specific days and times an ad campaign or ad squad is scheduled to run, determining its active periods for ad delivery.

ad_squad_idDimension

The unique identifier for an ad squad, which is a group of ads.

ad_squad_nameDimension

The name of the ad squad.

ad_squad_placementDimension

The placement where the ad squad's ads are displayed (e.g., Content, Story).

ad_squad_placement_v2_configDimension

Configuration settings for the ad squad's placements using the V2 placement system.

ad_squad_placement_v2_inclusionDimension

Inclusion rules for ad squad placements using the V2 placement system.

ad_squad_placement_v2_platformsDimension

The platforms where the ad squad's ads are allowed to be placed (e.g., Snapchat) using the V2 placement system.

ad_squad_placement_v2_snapchat_positionsDimension

Specific positions within Snapchat where the ad squad's ads are allowed to be placed (e.g., CHAT_FEED) using the V2 placement system.

ad_squad_targeting_demographics_genderDimension

Gender demographic targeting applied at the ad squad level.

ad_squad_targeting_demographics_languagesDimension

The demographic (e.g., age, gender) and language targeting settings for the ad squad.

ad_squad_targeting_demographics_max_ageDimension

Maximum age for demographic targeting applied at the ad squad level.

ad_squad_targeting_demographics_min_ageMetric

Minimum age for demographic targeting applied at the ad squad level.

ad_squad_targeting_geos_country_codeDimension

The two-letter ISO country code used to specify the geographical region for ad targeting within an Ad Squad. This field defines the countries where the ads in the Ad Squad will be displayed.

ad_squad_targeting_geos_excludedDimension

Geographic locations explicitly excluded from the ad squad's targeting.

ad_squad_targeting_geos_includedDimension

Geographic locations included in the targeting for the ad squad.

ad_squad_targeting_interests_category_idDimension

Category ID for interest-based targeting applied at the ad squad level.

ad_squad_targeting_locationsDimension

Specific geographic locations targeted by the ad squad.

ad_squad_targeting_regulated_contentDimension

Flag indicating if the ad squad's content is regulated (e.g., alcohol), requiring specific targeting considerations.

ad_squad_targeting_segments_excludedDimension

Customer list segments or other audience segments explicitly excluded from the ad squad's targeting.

ad_squad_targeting_segments_includedDimension

Audience segments included in the targeting for the ad squad.

advertiserad_account_advertiserDimension

The advertiser associated with the ad account.

advertiser_organization_idDimension

The unique identifier for the advertiser's organization.

age_bucketDimension

The age range or bucket of the audience targeted in Snapchat ads.

agencyDimension

The advertising agency associated with the campaign or ad account for reporting and organizational purposes.

agency_representing_clientDimension

Information about the advertising agency that manages the client's ad accounts.

android_installsMetric

The total number of app installs on Android devices attributed to the ad.

android_installs_app_viewMetric

The number of Android app installations attributed to an in-app ad view within the Snapchat platform.

android_installs_offline_viewMetric

The number of Android app installations attributed to an offline ad view or interaction, measured via server-to-server integration.

android_installs_swipe_upMetric

The number of app installs on Android devices attributed to users swiping up on the ad.

android_installs_viewMetric

The number of app installs on Android devices attributed to users who viewed the ad (view-through conversions).

android_installs_web_viewMetric

The number of Android app installations attributed to an ad view on a web browser or web property.

app_install_propertiesDimension

Properties and details related to app installs attributed to advertising campaigns, such as the platform or specific installation events.

attachment_avg_view_time_millisMetric

The average time, in milliseconds, that users viewed the attachment within the ad.

attachment_frequencyMetric

The average number of times a unique user viewed the ad's attachment.

attachment_impressionsMetric

The total number of times the ad's attachment was displayed.

attachment_quartile_{NUM}Metric

Video quartile data (e.g., 25%, 50%, 75%, 100%) for the ad's attachment.

attachment_total_view_time_millisMetric

The total time, in milliseconds, that users viewed the ad's attachment.

attachment_uniquesMetric

The number of unique users who viewed the ad's attachment.

attachment_video_viewsMetric

The number of video views for the ad's attachment.

attachment_view_completionMetric

The percentage of users who completed viewing the ad's attachment.

auto_bidDimension

A boolean flag indicating whether the ad platform automatically manages bids to achieve the most goal actions for the given budget and target audience.

auto_bid_max_bid_microMetric

The maximum bid amount, expressed in micro-currency, that the auto-bidding strategy is allowed to place for an ad.

avg_screen_time_millisMetric

The average time, in milliseconds, that users spent on screen interacting with the ad.

avg_view_time_millisMetric

The average time, in milliseconds, that users viewed the ad creative.

bid_microDimension

The bid amount for the ad squad, expressed in micro-currency units (1 local currency unit = 1,000,000 micro-currency).

bid_strategyad_squad_bid_strategyDimension

The strategy used for bidding on ad placements for the ad squad (e.g., goal-based bidding).

billing_center_idDimension

The unique identifier for the billing center associated with the ad account.

billing_eventad_squad_billing_eventDimension

The specific event or action for which an ad squad is billed, such as impressions or conversions.

billing_periodDimension

Specifies the billing period for the invoice.

billing_typeDimension

Defines the billing arrangement for the ad account, such as 'REVOLVING'.

brand_safety_configDimension

Defines where ads are placed among Snapchat content, allowing advertisers to control the suitability of the content surrounding their ads.

buy_modelDimension

The method used for purchasing ad space, such as 'AUCTION' for real-time bidding or 'RESERVED' for upfront reach and frequency buys.

call_to_actionDimension

The button or prompt within a creative that encourages users to take a specific action, such as 'Shop Now' or 'Install App'.

campaign_budget_optimization_propertiesDimension

Properties related to campaign budget optimization, defining how the budget is managed across ad squads within a campaign.

campaign_end_timeDimension

The scheduled end time for the campaign.

campaign_idDimension

The unique identifier for the campaign.

campaign_nameDimension

The name of the campaign.

campaign_objectiveDimension

The primary goal of the advertising campaign, such as app installs or website visits.

campaign_start_timeDimension

The scheduled start time for the campaign.

cap_and_exclusion_configDimension

Configuration for frequency capping and excluding certain audiences for an Ad Squad.

content_source_typeDimension
conversion_achievement_unlockedMetric

Total achievement unlocks attributed to ad engagement.

conversion_achievement_unlocked_appMetric

The number of 'achievement unlocked' conversion events attributed to an in-app ad view.

conversion_achievement_unlocked_offlineMetric

The number of 'achievement unlocked' conversion events attributed to an offline ad view or interaction.

conversion_achievement_unlocked_viewMetric

The number of times users unlocked an achievement after viewing an ad, indicating a specific conversion event.

conversion_achievement_unlocked_webMetric

The number of 'achievement unlocked' conversion events attributed to an ad view on a web browser.

conversion_ad_clickMetric

The total number of conversions attributed to ad clicks.

conversion_ad_click_appMetric

Total ad clicks occurring in an app.

conversion_ad_click_app_swipe_upMetric

The number of conversions resulting from a 'swipe up' action on an ad within the Snapchat app, indicating an ad click.

conversion_ad_click_app_viewMetric

The number of conversions resulting from an ad click attributed to an in-app ad view.

conversion_ad_click_offlineMetric

Total ad clicks occurring offline.

conversion_ad_click_offline_swipe_upMetric

The number of conversions resulting from a 'swipe up' action on an ad, attributed to an offline ad interaction.

conversion_ad_click_offline_viewMetric

The number of conversions resulting from an ad click attributed to an offline ad view or interaction.

conversion_ad_click_sk_ad_networkMetric

Conversion attributed to an ad click via Apple's SKAdNetwork.

conversion_ad_click_sk_ad_network_totalMetric

Total conversions attributed to an ad click via Apple's SKAdNetwork.

conversion_ad_click_sk_ad_network_viewMetric

Conversions attributed to a view-through ad interaction via Apple's SKAdNetwork.

conversion_ad_click_swipe_upMetric

The number of conversions attributed to ad clicks resulting from a swipe-up action.

conversion_ad_click_viewMetric

The number of conversions attributed to ad clicks from users who previously viewed the ad.

conversion_ad_click_webMetric

Total ad clicks occurring on the web.

conversion_ad_click_web_swipe_upMetric

The number of conversions resulting from a 'swipe up' action on an ad, attributed to an ad view on a web browser.

conversion_ad_click_web_viewMetric

The number of conversions resulting from an ad click attributed to an ad view on a web browser.

conversion_ad_viewMetric

The total number of conversions attributed to ad views (view-through conversions).

conversion_ad_view_appMetric

The number of ad view conversion events attributed to an in-app ad view.

conversion_ad_view_offlineMetric

The number of ad view conversion events attributed to an offline ad view or interaction.

conversion_ad_view_swipe_upMetric

The number of conversions attributed to ad views resulting from a swipe-up action.

conversion_ad_view_valueMetric

The attributed monetary or weighted value generated from a user viewing an ad across all conversion sources.

conversion_ad_view_value_appMetric

The monetary value generated from ad view conversion events attributed to an in-app ad view.

conversion_ad_view_value_offlineMetric

The monetary value generated from ad view conversion events attributed to an offline ad view or interaction.

conversion_ad_view_value_webMetric

The monetary value generated from ad view conversion events attributed to an ad view on a web browser.

conversion_ad_view_viewMetric

A conversion metric indicating that a user viewed an ad and subsequently performed a desired action, attributed to the view.

conversion_ad_view_webMetric

The number of ad view conversion events attributed to an ad view on a web browser.

conversion_add_billingMetric

The total number of 'add billing information' conversions attributed to the ad.

conversion_add_billing_appMetric

Total billing information additions occurring in an app attributed to ad engagement.

conversion_add_billing_offlineMetric

Total billing information additions occurring offline attributed to ad engagement.

conversion_add_billing_swipe_upMetric

The number of 'add billing information' conversions attributed to users swiping up on the ad.

conversion_add_billing_viewMetric

The number of 'add billing information' conversions attributed to users who viewed the ad (view-through conversions).

conversion_add_billing_webMetric

Total billing information additions occurring on the web attributed to ad engagement.

conversion_add_cartMetric

The total number of 'add to cart' conversions attributed to the ad.

conversion_add_cart_appMetric

Total additions to cart occurring in an app attributed to ad engagement.

conversion_add_cart_app_swipe_upMetric

Total additions to cart occurring in an app attributed to users swiping up on an ad, based on the swipe-up attribution window.

conversion_add_cart_app_viewMetric

Total additions to cart occurring in an app attributed to users viewing an ad, based on the view-through attribution window.

conversion_add_cart_offlineMetric

Total additions to cart occurring offline attributed to ad engagement.

conversion_add_cart_offline_swipe_upMetric

Total additions to cart occurring offline attributed to users swiping up on an ad, based on the swipe-up attribution window.

conversion_add_cart_offline_viewMetric

Total additions to cart occurring offline attributed to users viewing an ad, based on the view-through attribution window.

conversion_add_cart_sk_ad_networkMetric

Add-to-cart conversions attributed via Apple's SKAdNetwork.

conversion_add_cart_sk_ad_network_totalMetric

Total add-to-cart conversions attributed via Apple's SKAdNetwork.

conversion_add_cart_swipe_upMetric

The number of 'add to cart' conversions attributed to users swiping up on the ad.

conversion_add_cart_valueMetric

The monetary value generated from 'add to cart' conversions.

conversion_add_cart_value_appMetric

The monetary value generated from 'add to cart' conversion events attributed to an in-app ad view.

conversion_add_cart_value_offlineMetric

The monetary value generated from 'add to cart' conversion events attributed to an offline ad view or interaction.

conversion_add_cart_value_webMetric

The monetary value generated from 'add to cart' conversion events attributed to an ad view on a web browser.

conversion_add_cart_viewMetric

The number of 'add to cart' conversions attributed to users who viewed the ad (view-through conversions).

conversion_add_cart_webMetric

Total additions to cart occurring on the web attributed to ad engagement.

conversion_add_cart_web_swipe_upMetric

Total additions to cart occurring on the web attributed to users swiping up on an ad, based on the swipe-up attribution window.

conversion_add_cart_web_viewMetric

Total additions to cart occurring on the web attributed to users viewing an ad, based on the view-through attribution window.

conversion_add_to_wishlistMetric

The total number of 'add to wishlist' conversions attributed to the ad.

conversion_add_to_wishlist_appMetric

Total additions to wishlist occurring in an app attributed to ad engagement.

conversion_add_to_wishlist_offlineMetric

Total additions to wishlist occurring offline attributed to ad engagement.

conversion_add_to_wishlist_swipe_upMetric

The number of 'add to wishlist' conversions attributed to users swiping up on the ad.

conversion_add_to_wishlist_valueMetric

This field represents the monetary value associated with a user adding an item to their wishlist, tracked as a conversion event via the Snapchat Conversions API.

conversion_add_to_wishlist_viewMetric

The number of 'add to wishlist' conversions attributed to users who viewed the ad (view-through conversions).

conversion_add_to_wishlist_webMetric

Total additions to wishlist occurring on the web attributed to ad engagement.

conversion_app_opensMetric

Total app opens attributed to ad engagement.

conversion_app_opens_appMetric

Total app opens occurring in an app attributed to ad engagement.

conversion_app_opens_app_viewMetric

The number of 'app opens' conversion events attributed to an in-app ad view.

conversion_app_opens_offlineMetric

Total app opens occurring offline attributed to ad engagement.

conversion_app_opens_offline_viewMetric

The number of 'app opens' conversion events attributed to an offline ad view or interaction.

conversion_app_opens_swipe_upMetric

Total app opens attributed to users swiping up on an ad, based on the swipe-up attribution window.

conversion_app_opens_viewMetric

Total app opens attributed to users viewing an ad, based on the view-through attribution window.

conversion_app_opens_webMetric

Total app opens occurring on the web attributed to ad engagement.

conversion_app_opens_web_viewMetric

The number of 'app opens' conversion events attributed to an ad view on a web browser.

conversion_complete_tutorialMetric

Total completed tutorials attributed to ad engagement.

conversion_complete_tutorial_appMetric

Total completed tutorials occurring in an app attributed to ad engagement.

conversion_complete_tutorial_app_viewDimension

Total completed tutorials occurring in an app attributed to users viewing an ad, based on the view-through attribution window.

conversion_complete_tutorial_offlineMetric

Total completed tutorials occurring offline attributed to ad engagement.

conversion_complete_tutorial_offline_viewDimension

Total completed tutorials occurring offline attributed to users viewing an ad, based on the view-through attribution window.

conversion_complete_tutorial_viewDimension

Total completed tutorials attributed to users viewing an ad, based on the view-through attribution window.

conversion_complete_tutorial_webMetric

Total completed tutorials occurring on the web attributed to ad engagement.

conversion_complete_tutorial_web_viewDimension

Total completed tutorials occurring on the web attributed to users viewing an ad, based on the view-through attribution window.

conversion_inviteMetric

Total invites sent attributed to ad engagement.

conversion_invite_appMetric

Total invites sent occurring in an app attributed to ad engagement.

conversion_invite_offlineMetric

Total invites sent occurring offline attributed to ad engagement.

conversion_invite_webMetric

Total invites sent occurring on the web attributed to ad engagement.

conversion_level_completesMetric

Total level completions attributed to ad engagement.

conversion_level_completes_appMetric

Total level completions occurring in an app attributed to ad engagement.

conversion_level_completes_offlineMetric

Total level completions occurring offline attributed to ad engagement.

conversion_level_completes_viewMetric

The number of times users completed a specific level after viewing an ad, indicating a conversion event within an application.

conversion_level_completes_webMetric

Total level completions occurring on the web attributed to ad engagement.

conversion_list_viewMetric

Total times a list was viewed attributed to ad engagement.

conversion_list_view_appMetric

Total times a list was viewed occurring in an app attributed to ad engagement.

conversion_list_view_offlineMetric

Total times a list was viewed occurring offline attributed to ad engagement.

conversion_list_view_webMetric

Total times a list was viewed occurring on the web attributed to ad engagement.

conversion_loginMetric

Total logins attributed to ad engagement.

conversion_login_appMetric

Total logins occurring in an app attributed to ad engagement.

conversion_login_offlineMetric

Total logins occurring offline attributed to ad engagement.

conversion_login_webMetric

The number of times a user logged in on a website, attributed to an ad campaign.

conversion_page_viewsMetric

The total number of page view conversions attributed to the ad.

conversion_page_views_appMetric

The total number of page views within an app, attributed to an ad campaign.

conversion_page_views_offlineMetric

A conversion metric for offline page views after interacting with an ad.

conversion_page_views_swipe_upMetric

The number of page view conversions attributed to users swiping up on the ad.

conversion_page_views_valueMetric

The monetary value generated from page view conversions.

conversion_page_views_viewMetric

The number of page view conversions attributed to users who viewed the ad (view-through conversions).

conversion_page_views_webMetric

The total number of page views on a website, attributed to an ad campaign.

conversion_purchasesMetric

The total number of purchase conversions attributed to the ad.

conversion_purchases_appMetric

The total number of purchases made within an app, attributed to an ad campaign.

conversion_purchases_app_swipe_upDimension

The number of purchases made within an app, attributed to a swipe-up interaction with an ad.

conversion_purchases_app_viewDimension

The number of purchases made within an app, attributed to viewing an ad.

conversion_purchases_offlineMetric

The total number of offline purchases, attributed to an ad campaign.

conversion_purchases_offline_swipe_upMetric

The number of offline purchases, attributed to a swipe-up interaction with an ad.

conversion_purchases_offline_viewMetric

The number of offline purchases, attributed to viewing an ad.

conversion_purchases_sk_ad_networkMetric

Purchase conversions attributed via Apple's SKAdNetwork.

conversion_purchases_sk_ad_network_totalMetric

Total purchase conversions attributed via Apple's SKAdNetwork.

conversion_purchases_sk_ad_network_viewMetric

The number of view-through purchase conversions attributed via Apple's SKAdNetwork framework.

conversion_purchases_swipe_upMetric

The number of purchase conversions attributed to users swiping up on the ad.

conversion_purchases_valueMetric

The monetary value generated from purchase conversions attributed to the ad.

conversion_purchases_value_EURMetric

The value of purchase conversions, expressed in Euros.

conversion_purchases_value_appMetric

The total monetary value of purchases made within an app, attributed to an ad campaign.

conversion_purchases_value_app_swipe_upMetric

The monetary value of purchases made within an app, attributed to a swipe-up interaction with an ad.

conversion_purchases_value_app_viewMetric

The monetary value of purchases made within an app, attributed to viewing an ad.

conversion_purchases_value_offlineMetric

The total monetary value of offline purchases, attributed to an ad campaign.

conversion_purchases_value_offline_swipe_upMetric

The monetary value of offline purchases, attributed to a swipe-up interaction with an ad.

conversion_purchases_value_offline_viewMetric

The monetary value of offline purchases, attributed to viewing an ad.

conversion_purchases_value_swipe_upMetric

The monetary value generated from purchase conversions attributed to users swiping up on the ad.

conversion_purchases_value_viewMetric

The monetary value generated from purchase conversions attributed to users who viewed the ad (view-through conversions).

conversion_purchases_value_webMetric

The total monetary value of purchases made on a website, attributed to an ad campaign.

conversion_purchases_value_web_swipe_upMetric

The monetary value of purchases made on a website, attributed to a swipe-up interaction with an ad.

conversion_purchases_value_web_viewMetric

The monetary value of purchases made on a website, attributed to viewing an ad.

conversion_purchases_viewMetric

The number of purchase conversions attributed to users who viewed the ad (view-through conversions).

conversion_purchases_webMetric

The total number of purchases made on a website, attributed to an ad campaign.

conversion_purchases_web_swipe_upDimension

The number of purchases made on a website, attributed to a swipe-up interaction with an ad.

conversion_purchases_web_viewDimension

The number of purchases made on a website, attributed to viewing an ad.

conversion_rateMetric

The rate at which ad impressions or clicks lead to a desired conversion event.

conversion_rate_appMetric

The rate of conversions that occurred within an app, attributed to an ad campaign.

conversion_rate_offlineMetric

The rate of offline conversions, attributed to an ad campaign.

conversion_rate_swipe_upMetric

The percentage of users who swiped up on an ad after viewing it, indicating the effectiveness of the call to action.

conversion_rate_viewMetric

The percentage of ad views that resulted in a specific desired action or conversion.

conversion_rate_webMetric

The rate of conversions that occurred on a website, attributed to an ad campaign.

conversion_reserveMetric

The total number of reservation events attributed to an ad campaign.

conversion_reserve_appMetric

The number of reservation events that occurred within an app, attributed to an ad campaign.

conversion_reserve_offlineMetric

The number of offline reservation events, attributed to an ad campaign.

conversion_reserve_webMetric

The number of reservation events that occurred on a website, attributed to an ad campaign.

conversion_saveMetric

The total number of 'save' conversions attributed to the ad.

conversion_save_appMetric

The total number of save events that occurred within an app, attributed to an ad campaign.

conversion_save_offlineMetric

A conversion metric for offline saves after interacting with an ad.

conversion_save_swipe_upMetric

The number of 'save' conversions attributed to users swiping up on the ad.

conversion_save_valueMetric

The attributed monetary or weighted value generated from a user saving content or an item after interacting with an ad.

conversion_save_viewMetric

The number of 'save' conversions attributed to users who viewed the ad (view-through conversions).

conversion_save_webMetric

The total number of save events that occurred on a website, attributed to an ad campaign.

conversion_searchesMetric

The total number of 'search' conversions attributed to the ad.

conversion_searches_appMetric

The total number of search events that occurred within an app, attributed to an ad campaign.

conversion_searches_offlineMetric

A conversion metric for offline searches after interacting with an ad.

conversion_searches_swipe_upMetric

The number of 'search' conversions attributed to users swiping up on the ad.

conversion_searches_valueMetric

The attributed monetary or weighted value generated from a user performing a search after interacting with an ad.

conversion_searches_viewMetric

The number of 'search' conversions attributed to users who viewed the ad (view-through conversions).

conversion_searches_webMetric

The total number of search events that occurred on a website, attributed to an ad campaign.

conversion_shareMetric

The total number of share conversions attributed to the ad.

conversion_share_appMetric

The total number of share events that occurred within an app, attributed to an ad campaign.

conversion_share_offlineMetric

A conversion metric for offline shares after interacting with an ad.

conversion_share_swipe_upMetric

The number of 'share' conversions attributed to users swiping up on the ad.

conversion_share_valueMetric

The attributed monetary or weighted value generated from a user sharing content after interacting with an ad.

conversion_share_viewMetric

Total shares of content attributed to ad views, based on the view-through attribution window.

conversion_share_webMetric

The total number of share events that occurred on a website, attributed to an ad campaign.

conversion_sign_upsMetric

Total sign-ups attributed to ad engagement.

conversion_sign_ups_appMetric

The total number of sign-up events that occurred within an app, attributed to an ad campaign.

conversion_sign_ups_offlineMetric

A conversion metric for offline sign-ups after interacting with an ad.

conversion_sign_ups_swipe_upMetric

Total sign-ups attributed specifically to users swiping up on an ad, based on the swipe-up attribution window.

conversion_sign_ups_valueMetric

The monetary value generated from sign-up conversions.

conversion_sign_ups_value_appMetric

The monetary value generated from 'sign up' conversion events attributed to an in-app ad view.

conversion_sign_ups_value_offlineMetric

The monetary value generated from 'sign up' conversion events attributed to an offline ad view or interaction.

conversion_sign_ups_value_webMetric

The monetary value generated from 'sign up' conversion events attributed to an ad view on a web browser.

conversion_sign_ups_viewMetric

Total sign-ups attributed specifically to users viewing an ad, based on the view-through attribution window.

conversion_sign_ups_webMetric

The total number of sign-up events that occurred on a website, attributed to an ad campaign.

conversion_spend_creditsMetric

A conversion metric for users who spent credits after interacting with an ad.

conversion_spend_credits_appMetric

The value of spend credits attributed to app conversion events.

conversion_spend_credits_offlineMetric

The value of spend credits attributed to offline conversion events.

conversion_spend_credits_webMetric

The value of spend credits attributed to web conversion events.

conversion_start_checkoutMetric

Total times users initiated a checkout process attributed to ad engagement.

conversion_start_checkout_appMetric

The total number of times users started the checkout process within an app, attributed to an ad campaign.

conversion_start_checkout_app_swipe_upDimension

The number of times users started the checkout process within an app, attributed to a swipe-up interaction with an ad.

conversion_start_checkout_app_viewDimension

The number of times users started the checkout process within an app, attributed to viewing an ad.

conversion_start_checkout_offlineMetric

A conversion metric for users who started an offline checkout process after interacting with an ad.

conversion_start_checkout_offline_swipe_upMetric

A conversion metric for users who started an offline checkout process after swiping up on an ad.

conversion_start_checkout_offline_viewDimension

A conversion metric for users who started an offline checkout process after viewing an ad.

conversion_start_checkout_swipe_upMetric

Total times users initiated a checkout process attributed to users swiping up on an ad, based on the swipe-up attribution window.

conversion_start_checkout_viewMetric

Total times users initiated a checkout process attributed to users viewing an ad, based on the view-through attribution window.

conversion_start_checkout_webMetric

The total number of times users started the checkout process on a website, attributed to an ad campaign.

conversion_start_checkout_web_swipe_upDimension

The number of times users started the checkout process on a website, attributed to a swipe-up interaction with an ad.

conversion_start_checkout_web_viewDimension

The number of times users started the checkout process on a website, attributed to viewing an ad.

conversion_start_trialMetric

A conversion metric for users who started a trial after interacting with an ad.

conversion_start_trial_appMetric

A conversion metric for users who started an app trial after interacting with an ad.

conversion_start_trial_offlineMetric

A conversion metric for users who started an offline trial after interacting with an ad.

conversion_start_trial_swipe_upMetric

Represents the number of 'start trial' conversions attributed to users who swiped up on the ad.

conversion_start_trial_viewMetric

Represents the number of 'start trial' conversions attributed to users who viewed the ad.

conversion_start_trial_webMetric

A conversion metric for users who started a web trial after interacting with an ad.

conversion_subscribeMetric

Total subscriptions attributed to ad engagement.

conversion_subscribe_appMetric

The total number of subscription events that occurred within an app, attributed to an ad campaign.

conversion_subscribe_app_viewMetric

The number of 'subscribe' conversion events attributed to an in-app ad view.

conversion_subscribe_offlineMetric

A conversion metric for offline subscriptions after interacting with an ad.

conversion_subscribe_offline_viewMetric

The number of 'subscribe' conversion events attributed to an offline ad view or interaction.

conversion_subscribe_swipe_upMetric

Total subscriptions attributed specifically to users swiping up on an ad, based on the swipe-up attribution window.

conversion_subscribe_valueMetric

The attributed monetary or weighted value generated from a user subscribing after interacting with an ad.

conversion_subscribe_value_appMetric

The monetary value generated from 'subscribe' conversion events attributed to an in-app ad view.

conversion_subscribe_value_offlineMetric

The monetary value generated from 'subscribe' conversion events attributed to an offline ad view or interaction.

conversion_subscribe_value_webMetric

The monetary value generated from 'subscribe' conversion events attributed to an ad view on a web browser.

conversion_subscribe_viewMetric

Total subscriptions attributed specifically to users viewing an ad, based on the view-through attribution window.

conversion_subscribe_webMetric

The total number of subscription events that occurred on a website, attributed to an ad campaign.

conversion_subscribe_web_viewMetric

The number of 'subscribe' conversion events attributed to an ad view on a web browser.

conversion_view_contentMetric

Total views of specific content attributed to ad engagement.

conversion_view_content_appMetric

The total number of content view events that occurred within an app, attributed to an ad campaign.

conversion_view_content_offlineMetric

A conversion metric for offline content views after interacting with an ad.

conversion_view_content_swipe_upMetric

Total views of specific content attributed specifically to users swiping up on an ad, based on the swipe-up attribution window.

conversion_view_content_valueMetric

The attributed monetary or weighted value generated from a user viewing specific content after interacting with an ad.

conversion_view_content_viewMetric

Total views of specific content attributed specifically to users viewing an ad, based on the view-through attribution window.

conversion_view_content_webMetric

The total number of content view events that occurred on a website, attributed to an ad campaign.

conversion_visitMetric

Attributed visit conversion events.

conversion_visit_appMetric

The number of visit conversion events that occurred within an app.

conversion_visit_offlineMetric

A conversion metric for offline visits after interacting with an ad.

conversion_visit_webMetric

The number of visit conversion events that occurred on a website.

conversion_windowDimension

The defined period of time (e.g., 7-day click, 1-day view) during which a conversion can be attributed to an ad engagement.

countryDimension

This field represents the geographical country where an advertising campaign is targeted, or for which performance data (like impressions and engagements) is reported. It can be used as a dimension to break down metrics.

created_atDimension

The timestamp when the entity was created.

created_at_dateDimension

The date when the entity (e.g., campaign, ad, creative) was created.

creation_stateDimension

The current state of an ad entity at its creation, such as DRAFT or PENDING.

creative_clickthrough_urlDimension

The URL that users are directed to when they interact with the ad creative.

creative_composite_propertiesDimension

A collection of various properties that define the complex characteristics of a creative.

creative_idDimension

The unique identifier for the creative asset used in an ad.

creative_nameDimension

The name of the creative asset.

creative_preview_propertiesDimension

Properties related to how an ad creative appears in a preview, including its format and content.

creator_partnership_typeDimension

The type of partnership established with a creator, such as sponsored content or brand collaboration.

cta_color_display_modeDimension

Defines the color display mode for the Call-to-Action button on a creative, such as DEFAULT_COLOR or AUTO_COLOR_DETECTION.

currencyad_account_currencyDimension

The currency used for the ad account.

custom_conversion[{PLACEHOLDER}]Metric

A dynamically named custom conversion event.

custom_conversion_idDimension

A unique identifier for a custom conversion event defined by the advertiser.

custom_event_{NUM}Metric

Total occurrences of a custom conversion event, where {NUM} represents the unique ID of the custom conversion.

custom_event_{NUM}_appMetric

The total count of a custom event (specified by {NUM}) occurring within an app, attributed to an ad campaign.

custom_event_{NUM}_offlineMetric

A custom offline conversion event tracked after interacting with an ad, identified by a number.

custom_event_{NUM}_swipe_upMetric

Total occurrences of a custom conversion event, where {NUM} represents the unique ID, attributed to users swiping up on an ad.

custom_event_{NUM}_valueMetric

The specific value associated with a custom conversion event, as defined by the advertiser. This allows for granular reporting and optimization by tracking additional data points beyond standard conversion metrics, such as a purchase amount or an item ID.

custom_event_{NUM}_viewMetric

Total occurrences of a custom conversion event, where {NUM} represents the unique ID, attributed to users viewing an ad.

custom_event_{NUM}_webMetric

The total count of a custom event (specified by {NUM}) occurring on a website, attributed to an ad campaign.

customer.nameDimension

The name of the customer associated with the invoice.

customer.netsuite_idDimension

The internal Snap ID for the customer.

daily_budget_microMetric

The daily budget for a campaign, expressed in micro-currency units.

dateDimension

The specific date for which the data is reported.

dayDimension

This field represents the specific day for which performance data or insights are reported, allowing for daily granularity in analysis.

deletedcampaign_deletedDimension

Indicates whether the campaign or entity has been deleted.

delivery_constraintDimension

Defines the budget type for ad delivery, such as daily or lifetime budget.

delivery_constraint_sub_typeDimension

A specific sub-type of the delivery constraint, further defining how the ad budget is managed.

delivery_statusDimension

The current status of an ad campaign, ad squad, or ad regarding its delivery, such as DELIVERING or PAUSED.

demo_media_idDimension
dmaDimension

This field represents the Designated Market Area (DMA) targeted by an advertising campaign, used for audience segmentation and reporting of performance data. It is a geographical dimension.

dma_nameDimension

The Designated Market Area (DMA) of the audience targeted in Snapchat ads.

document_numberMetric

The document number of the invoice.

due_dateDimension

The due date of the invoice.

due_date_dateDimension

The date component of the invoice's due date.

earned_impressionsMetric

Impressions generated through organic sharing or viral spread of the ad content, rather than paid placements.

earned_reachMetric

The number of unique users reached through organic sharing or viral spread of the ad content.

end_timeDimension

The scheduled end date and time for the advertising campaign.

event_sourcesDimension

The sources from which conversion or other tracked events are reported, such as in-app SDKs, pixels, or offline uploads.

experiment_idDimension

A unique identifier for an advertising experiment or A/B test, used to track and analyze the performance of different ad variations or strategies.

favorite_display_modeDimension

Controls whether users can favorite the creative within the Snapchat App, with options like SHOW or HIDE.

forced_view_eligibilityDimension

Indicates if a creative can be used as a commercial, specifying options like FULL_DURATION, SIX_SECONDS, or NONE.

frequencyMetric

The average number of times a unique user saw the ad.

funding_source_idsDimension

A list of identifiers for the funding sources used for the ad account or campaign.

gross_impressionsMetric

The total number of times an ad was displayed, including repeated displays to the same user.

idorganization_idDimension

The unique identifier for the ad.

impression_goalMetric

The target number of impressions set for an ad campaign or ad squad.

impressionsMetric

The total number of times the ad was displayed.

interest_category_idDimension

The unique identifier for a target audience interest category.

interest_category_nameDimension

The name of a specific interest category used for audience targeting.

invoice_idDimension

The unique identifier for the invoice.

invoice_statusDimension

Indicates the collection status of the invoice, such as COLLECTED or SENT_FOR_COLLECTION.

ios_installsMetric

The total number of app installs on iOS devices attributed to the ad.

ios_installs_app_viewMetric

The number of iOS app installations attributed to an in-app ad view within the Snapchat platform.

ios_installs_offline_viewMetric

The number of iOS app installations attributed to an offline ad view or interaction, measured via server-to-server integration.

ios_installs_swipe_upMetric

The number of app installs on iOS devices attributed to users swiping up on the ad.

ios_installs_viewMetric

The number of app installs on iOS devices attributed to users who viewed the ad (view-through conversions).

ios_installs_web_viewMetric

The number of iOS app installations attributed to an ad view on a web browser or web property.

landing_page_viewsMetric

The total number of views for the landing page associated with an advertisement.

last_modifiedDimension

The date and time when the invoice was last modified.

last_modified_dateDimension

The date component of when the invoice was last modified.

lens_package_metadataDimension

Metadata associated with a Snapchat Lens package.

lifetime_budget_microMetric

The total budget allocated for the entire duration of an ad squad's campaign, expressed in micro-units of the currency (e.g., 1,000,000 micro = 1 unit of currency).

lifetime_spend_cap_microMetric

The maximum total amount that can be spent on a campaign over its entire lifespan, expressed in micro-units of the currency.

line_last_modifiedDimension

The date and time when an invoice line item was last modified.

max_reach_goalMetric

The maximum target for the number of unique users an ad campaign aims to reach.

measured_impressionsMetric

The number of ad impressions that were successfully measured for viewability, indicating they met industry standards for being seen.

media_costMetric

The expenditure associated with an advertising campaign or ad, representing the total amount spent on media placements. This is often referred to as 'Spend' in performance reporting.

media_usagesDimension
min_reach_goalMetric

The minimum target for the number of unique users an ad campaign aims to reach.

nameorganization_nameDimension

The name of the organization associated with the ad account.

native_leadsMetric

The number of leads generated directly through Snapchat's native lead generation forms.

non_viewable_impressionsMetric

The number of ad impressions that did not meet the industry standards for viewability and were therefore not considered seen by a user.

objectiveDimension

The marketing objective of the advertising campaign (e.g., app installs, brand awareness, conversions).

objective_v2_propertiesDimension

Properties and settings defining the objective of the campaign, using version 2 of the objective model.

operating_systemDimension

The operating system of the device on which an ad is displayed, often used for ad targeting or performance breakdown.

optimization_goalad_squad_optimization_goalDimension

The goal for which the ad squad is optimized, influencing bid strategy and delivery (e.g., app installs, purchases).

org_idDimension

The unique identifier for the organization.

pacing_levelDimension

Indicates the organizational level at which pacing settings are applied, such as 'CAMPAIGN' level.

pacing_properties_versionMetric

The version of the pacing properties applied to an advertising campaign or ad squad, which dictates how the budget is spent over a specific period.

pacing_typeDimension

Defines how the ad spend is distributed over time for an ad campaign or ad squad.

packaging_statusDimension
paid_impressionsMetric

Impressions generated from paid placements of the ad content.

pixel_idDimension

A unique identifier for the Snap Pixel, used to track web, app, and offline conversion events.

placementDimension

Specifies where an ad will be displayed on the Snapchat platform, such as in Stories, Spotlight, or between content.

position_impressionsMetric

The number of impressions recorded for the ad in a specific placement position.

position_swipe_up_percentMetric

The percentage of impressions in a specific position that resulted in a swipe-up action.

post_ad_preview_urlDimension

A URL that provides a preview of the ad after it has been created and posted.

premium_content_bundle_idsDimension
preview_creative_idcreative_preview_creative_idDimension

The unique identifier for a creative asset used for preview purposes.

primary_profileDimension

The identifier or details of the primary public profile linked to the ad account or organization.

product_propertiesDimension

Custom properties associated with a product, often used for detailed reporting and segmentation of product-related events.

profile_propertiesDimension

Various attributes and settings associated with a public profile, such as display information or configurations.

quartile_{NUM}Metric

Video quartile data (e.g., 25%, 50%, 75%, 100%) for video views within the ad creative.

reach_and_frequency_rate_microMetric

The rate for reach and frequency campaigns, expressed in micro-currency units.

reach_and_frequency_statusDimension

The current status of a reach and frequency ad squad, such as PENDING, ACTIVE, or FAILED.

reach_goalMetric

The target number of unique users an ad campaign aims to reach.

regionDimension

This field indicates the geographical region targeted by an advertising campaign or for which performance data is reported. It can be used as a dimension for insights and targeting.

regulationsDimension

Specifies regulatory requirements or classifications for ads, particularly for sensitive categories like Housing, Credit, or Employment.

render_typeDimension

The format or method used to display an ad creative, such as image, video, or interactive experiences.

reserved_typeDimension

The type of reserved ad buy.

review_statusad_review_statusDimension

The current review status of the ad (e.g., Pending, Approved, Rejected).

review_status_detailsDimension

Detailed information regarding the review status of an ad or creative, explaining approval, rejection, or pending states.

review_status_reasonad_review_status_reasonDimension

The reason provided for the current review status of an ad, if it's not approved.

review_status_reasonsDimension

The specific reasons provided for an ad's review status, especially if it was rejected or flagged for issues.

savesMetric

The number of times users saved the ad content.

screen_time_millisMetric

The total time, in milliseconds, that users spent on screen interacting with the ad.

semantic_idDimension
shareableDimension

Indicates whether the creative content is shareable by users.

skadnetwork_propertiesDimension

Properties and configurations related to Apple's SKAdNetwork for privacy-focused app install attribution and measurement.

spendMetric

The total amount of money spent on the advertising campaign.

spend_EURMetric

The total amount spent on the ad campaign, expressed in Euros.

start_timeDimension

The scheduled start date and time for the advertising campaign.

statuscampaign_statusDimension

The current status of the advertising campaign (e.g., Active, Paused, Completed).

story_completesMetric

The number of times users watched the entire ad creative within a story format.

story_opensMetric

The number of times a user opened the story containing the ad.

swipe_up_percentMetric

The percentage of users who swiped up on the ad after viewing it.

swipesMetric

The total number of times users swiped up on the ad.

takeover_slotMetric

Refers to a premium advertising placement option, such as 'Total Snap Takeovers', where a brand's ad appears as the first ad across multiple Snapchat app tabs (e.g., Map, Chat, Camera, Stories, Spotlight) for a user's session.

target_bidDimension

The target bid amount set for an ad squad, used in conjunction with bidding strategies to optimize ad delivery.

targeting.app_install_statesDimension

Targeting option that defines whether the intended audience has a specific app installed or not.

targeting.auto_expansion_optionsDimension

Options for automatically expanding the target audience based on factors like interests or custom audiences.

targeting.demographicsDimension

Demographic targeting parameters such as age range, gender, and language to define the audience for ads.

targeting.devicesDimension

Device-specific targeting options, including operating system, device make, and connection type (e.g., Wi-Fi, cellular).

targeting.enable_targeting_expansionDimension

(Deprecated) A flag to enable or disable targeting expansion for an ad squad. This attribute is being replaced by `auto_expansion_options`.

targeting.geosDimension

Geographic targeting parameters, allowing advertisers to specify locations such as countries, regions, cities, or custom areas.

targeting.interestsDimension

Targeting options based on user interests, behaviors, and daily activities.

targeting.locationsDimension

This field represents the geographical locations targeted by advertising campaigns on Snapchat. It enables the collection of performance insights, such as impressions, swipes, and spend, broken down by various geographical dimensions like country, region, or city. This data provides a detailed view of how campaigns perform in specific targeted areas.

targeting.maid_status_specDimension

Specifies the Mobile Ad ID (MAID) status criteria used for audience targeting.

targeting.product_audiencesDimension

The specific audience segments defined by product interests or usage, used to target ads.

targeting.regulated_contentDimension

A flag indicating whether the ad's content is regulated (e.g., alcohol), which requires specific age and country targeting considerations.

targeting.segmentsDimension

Targeting based on customer list segments or other predefined audience segments.

targeting.separated_typesDimension

Indicates if a targeting specification type has been separated into a new entity.

targeting_reach_statusDimension

The status of the campaign's targeting reach, indicating if the targeting configuration is valid.

third_party_on_swipe_tracking_urlsDimension

URLs used to track swipe-up actions on an ad via third-party measurement services.

third_party_paid_impression_tracking_urlsDimension

URLs used to track impressions of paid advertising campaigns via third-party measurement services.

third_party_tracking_urlsDimension

URLs used for general tracking of ad performance and user interactions through third-party measurement providers.

timezonead_account_timezoneDimension

The timezone configured for the ad account.

top_snap_crop_positionDimension

Specifies the position of the cropped ad creative, particularly relevant for 'Top Snap' ad formats to ensure optimal display.

top_snap_media_idcreative_top_snap_media_idDimension

The unique identifier for the primary media asset (Top Snap) used in a creative.

total_impressionsMetric

The cumulative total of all impressions generated by the ad.

total_installsMetric

The overall number of app installs attributed to the ad across all device types.

total_installs_appMetric

The total number of app installs.

total_installs_app_viewMetric

The total number of app installations (Android and iOS) attributed to an in-app ad view within the Snapchat platform.

total_installs_offlineMetric

The total number of installs attributed to offline events.

total_installs_offline_viewMetric

The total number of app installations (Android and iOS) attributed to an offline ad view or interaction, measured via server-to-server integration.

total_installs_swipe_upMetric

The total number of app installs attributed to users swiping up on the ad across all device types.

total_installs_viewMetric

The total number of app installs attributed to users who viewed the ad (view-through conversions) across all device types.

total_installs_webMetric

The total number of installs attributed to web events.

total_installs_web_viewMetric

The total number of app installations (Android and iOS) attributed to an ad view on a web browser or web property.

total_reachMetric

The total number of unique users who saw the ad at least once.

typead_typeDimension

The specific type of ad creative or ad format.

uniquesMetric

The total number of unique users who saw or interacted with the ad.

unlockable_idDimension

A unique identifier for content or features that can be unlocked by users, possibly through ad interaction or specific conditions.

updated_atDimension

The timestamp when the entity was last updated.

utm_autofix_permissionDimension

Permission setting that allows the Snapchat platform to automatically adjust or correct UTM (Urchin Tracking Module) parameters for tracking URLs.

video_viewsMetric

The total number of times the video ad creative was viewed.

video_views_15sMetric

The number of times the video ad creative was viewed for at least 15 seconds.

video_views_5sMetric

The total number of video views lasting at least 5 seconds.

video_views_time_basedMetric

Video views measured based on a specific time threshold, indicating a longer view duration.

view_completionMetric

The percentage of users who completed viewing the ad creative.

view_time_millisMetric

The total time, in milliseconds, that the ad creative was viewed.

viewable_impressionsMetric

The number of ad impressions that were considered viewable according to industry standards.

viewable_rateMetric

The percentage of total impressions that were considered viewable.

web_view_propertiesDimension

Properties and settings related to the in-app web view experience when users interact with an ad that directs to a web page.