Snapchat: Most-used fields

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
Gender gender Dimension

The gender of the audience targeted in Snapchat ads.

ad_account_id Dimension

The unique identifier for the ad account.

ad_account_name Dimension

The name of the ad account.

ad_id Dimension

The unique identifier for an individual ad.

ad_name Dimension

The name of the ad.

ad_product creative_ad_product Dimension

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

ad_scheduling_config Dimension

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_id Dimension

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

ad_squad_name Dimension

The name of the ad squad.

ad_squad_placement Dimension

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

ad_squad_placement_v2_config Dimension

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

ad_squad_placement_v2_inclusion Dimension

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

ad_squad_placement_v2_platforms Dimension

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_positions Dimension

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_gender Dimension

Gender demographic targeting applied at the ad squad level.

ad_squad_targeting_demographics_languages Dimension

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

ad_squad_targeting_demographics_max_age Dimension

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

ad_squad_targeting_demographics_min_age Metric

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

ad_squad_targeting_geos_country_code Dimension

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_excluded Dimension

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

ad_squad_targeting_geos_included Dimension

Geographic locations included in the targeting for the ad squad.

ad_squad_targeting_interests_category_id Dimension

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

ad_squad_targeting_locations Dimension

Specific geographic locations targeted by the ad squad.

ad_squad_targeting_regulated_content Dimension

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

ad_squad_targeting_segments_excluded Dimension

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

ad_squad_targeting_segments_included Dimension

Audience segments included in the targeting for the ad squad.

advertiser ad_account_advertiser Dimension

The advertiser associated with the ad account.

advertiser_organization_id Dimension

The unique identifier for the advertiser's organization.

age_bucket Dimension

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

agency Dimension

The advertising agency associated with the campaign or ad account.

agency_representing_client Dimension

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

android_installs Metric

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

android_installs_swipe_up Metric

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

android_installs_view Metric

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

attachment_avg_view_time_millis Metric

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

attachment_frequency Metric

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

attachment_impressions Metric

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_millis Metric

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

attachment_uniques Metric

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

attachment_video_views Metric

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

attachment_view_completion Metric

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

auto_bid Dimension

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_micro Metric

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

avg_screen_time_millis Metric

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

avg_view_time_millis Metric

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

bid_micro Dimension

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

bid_strategy Dimension

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

billing_center_id Dimension

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

billing_event Dimension

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

billing_type Dimension

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

brand_safety_config Dimension

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

buy_model Dimension

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

call_to_action creative_call_to_action Dimension

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_properties Dimension

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

campaign_end_time Dimension

The scheduled end time for the campaign.

campaign_id Dimension

The unique identifier for the campaign.

campaign_name Dimension

The name of the campaign.

campaign_objective Dimension

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

campaign_start_time Dimension

The scheduled start time for the campaign.

cap_and_exclusion_config Dimension

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

conversion_achievement_unlocked Metric

Total achievement unlocks attributed to ad engagement.

conversion_ad_click Metric

The total number of conversions attributed to ad clicks.

conversion_ad_click_app Metric

Total ad clicks occurring in an app.

conversion_ad_click_offline Metric

Total ad clicks occurring offline.

conversion_ad_click_sk_ad_network Metric

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

conversion_ad_click_sk_ad_network_total Metric

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

conversion_ad_click_sk_ad_network_view Metric

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

conversion_ad_click_swipe_up Metric

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

conversion_ad_click_view Metric

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

conversion_ad_click_web Metric

Total ad clicks occurring on the web.

conversion_ad_view Metric

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

conversion_ad_view_swipe_up Metric

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

conversion_ad_view_value Metric

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

conversion_ad_view_view Metric

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

conversion_add_billing Metric

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

conversion_add_billing_app Metric

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

conversion_add_billing_offline Metric

Total billing information additions occurring offline attributed to ad engagement.

conversion_add_billing_swipe_up Metric

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

conversion_add_billing_value Metric

The monetary value generated from 'add billing' conversion events.

conversion_add_billing_view Metric

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

conversion_add_billing_web Metric

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

conversion_add_cart Metric

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

conversion_add_cart_app Metric

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

conversion_add_cart_app_swipe_up Metric

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_view Metric

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

conversion_add_cart_offline Metric

Total additions to cart occurring offline attributed to ad engagement.

conversion_add_cart_offline_swipe_up Metric

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_view Metric

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

conversion_add_cart_sk_ad_network Metric

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

conversion_add_cart_sk_ad_network_total Metric

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

conversion_add_cart_swipe_up Metric

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

conversion_add_cart_value Metric

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

conversion_add_cart_view Metric

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

conversion_add_cart_web Metric

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

conversion_add_cart_web_swipe_up Metric

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_view Metric

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

conversion_add_to_wishlist Metric

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

conversion_add_to_wishlist_app Metric

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

conversion_add_to_wishlist_offline Metric

Total additions to wishlist occurring offline attributed to ad engagement.

conversion_add_to_wishlist_swipe_up Metric

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

conversion_add_to_wishlist_value Metric

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_view Metric

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

conversion_add_to_wishlist_web Metric

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

conversion_app_opens Metric

Total app opens attributed to ad engagement.

conversion_app_opens_app Dimension

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

conversion_app_opens_offline Dimension

Total app opens occurring offline attributed to ad engagement.

conversion_app_opens_swipe_up Metric

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

conversion_app_opens_view Metric

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

conversion_app_opens_web Dimension

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

conversion_complete_tutorial Metric

Total completed tutorials attributed to ad engagement.

conversion_complete_tutorial_app Dimension

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

conversion_complete_tutorial_app_view Dimension

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

conversion_complete_tutorial_offline Dimension

Total completed tutorials occurring offline attributed to ad engagement.

conversion_complete_tutorial_offline_view Dimension

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

conversion_complete_tutorial_view Dimension

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

conversion_complete_tutorial_web Dimension

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

conversion_complete_tutorial_web_view Dimension

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

conversion_invite Metric

Total invites sent attributed to ad engagement.

conversion_invite_app Metric

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

conversion_invite_offline Metric

Total invites sent occurring offline attributed to ad engagement.

conversion_invite_web Metric

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

conversion_level_completes Metric

Total level completions attributed to ad engagement.

conversion_level_completes_app Metric

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

conversion_level_completes_offline Metric

Total level completions occurring offline attributed to ad engagement.

conversion_level_completes_web Metric

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

conversion_list_view Metric

Total times a list was viewed attributed to ad engagement.

conversion_list_view_app Metric

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

conversion_list_view_offline Metric

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

conversion_list_view_web Metric

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

conversion_login Metric

Total logins attributed to ad engagement.

conversion_login_app Metric

Total logins occurring in an app attributed to ad engagement.

conversion_login_offline Metric

Total logins occurring offline attributed to ad engagement.

conversion_login_web Metric

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

conversion_page_views Metric

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

conversion_page_views_app Dimension

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

conversion_page_views_offline Dimension

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

conversion_page_views_swipe_up Metric

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

conversion_page_views_value Metric

The monetary value generated from page view conversions.

conversion_page_views_view Metric

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

conversion_page_views_web Dimension

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

conversion_purchases Metric

The total number of purchase conversions attributed to the ad.

conversion_purchases_app Metric

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

conversion_purchases_app_swipe_up Dimension

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

conversion_purchases_app_view Metric

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

conversion_purchases_offline Metric

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

conversion_purchases_offline_swipe_up Metric

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

conversion_purchases_offline_view Metric

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

conversion_purchases_sk_ad_network Metric

Purchase conversions attributed via Apple's SKAdNetwork.

conversion_purchases_sk_ad_network_total Metric

Total purchase conversions attributed via Apple's SKAdNetwork.

conversion_purchases_sk_ad_network_view Metric

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

conversion_purchases_swipe_up Metric

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

conversion_purchases_value Metric

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

conversion_purchases_value_EUR Metric

The value of purchase conversions, expressed in Euros.

conversion_purchases_value_app Metric

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

conversion_purchases_value_app_swipe_up Metric

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

conversion_purchases_value_app_view Metric

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

conversion_purchases_value_offline Metric

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

conversion_purchases_value_offline_swipe_up Metric

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

conversion_purchases_value_offline_view Metric

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

conversion_purchases_value_swipe_up Metric

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

conversion_purchases_value_view Metric

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

conversion_purchases_value_web Metric

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

conversion_purchases_value_web_swipe_up Metric

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

conversion_purchases_value_web_view Metric

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

conversion_purchases_view Metric

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

conversion_purchases_web Metric

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

conversion_purchases_web_swipe_up Dimension

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

conversion_purchases_web_view Metric

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

conversion_rate Dimension

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

conversion_rate_app Metric

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

conversion_rate_offline Metric

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

conversion_rate_web Metric

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

conversion_reserve Metric

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

conversion_reserve_app Metric

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

conversion_reserve_offline Metric

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

conversion_reserve_web Metric

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

conversion_save Metric

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

conversion_save_app Dimension

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

conversion_save_offline Dimension

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

conversion_save_swipe_up Metric

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

conversion_save_value Metric

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

conversion_save_view Metric

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

conversion_save_web Dimension

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

conversion_searches Metric

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

conversion_searches_app Metric

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

conversion_searches_offline Metric

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

conversion_searches_swipe_up Metric

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

conversion_searches_value Metric

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

conversion_searches_view Metric

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

conversion_searches_web Metric

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

conversion_share Metric

The total number of share conversions attributed to the ad.

conversion_share_app Dimension

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

conversion_share_offline Dimension

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

conversion_share_swipe_up Metric

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

conversion_share_value Metric

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

conversion_share_view Metric

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

conversion_share_web Dimension

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

conversion_sign_ups Metric

Total sign-ups attributed to ad engagement.

conversion_sign_ups_app Metric

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

conversion_sign_ups_offline Metric

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

conversion_sign_ups_swipe_up Metric

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

conversion_sign_ups_value Metric

The monetary value generated from sign-up conversions.

conversion_sign_ups_view Metric

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

conversion_sign_ups_web Metric

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

conversion_spend_credits Metric

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

conversion_start_checkout Metric

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

conversion_start_checkout_app Dimension

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

conversion_start_checkout_app_swipe_up Dimension

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_view Dimension

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

conversion_start_checkout_offline Metric

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

conversion_start_checkout_offline_swipe_up Metric

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

conversion_start_checkout_offline_view Dimension

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

conversion_start_checkout_swipe_up Metric

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_value Metric

The total monetary value generated from 'start checkout' conversions across all sources.

conversion_start_checkout_view Metric

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

conversion_start_checkout_web Dimension

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

conversion_start_checkout_web_swipe_up Dimension

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_view Dimension

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

conversion_start_trial Metric

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

conversion_start_trial_app Metric

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

conversion_start_trial_offline Metric

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

conversion_start_trial_swipe_up Metric

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

conversion_start_trial_view Metric

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

conversion_start_trial_web Metric

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

conversion_subscribe Metric

Total subscriptions attributed to ad engagement.

conversion_subscribe_app Metric

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

conversion_subscribe_offline Metric

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

conversion_subscribe_swipe_up Metric

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

conversion_subscribe_value Metric

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

conversion_subscribe_view Metric

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

conversion_subscribe_web Metric

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

conversion_view_content Metric

Total views of specific content attributed to ad engagement.

conversion_view_content_app Dimension

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

conversion_view_content_offline Dimension

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

conversion_view_content_swipe_up Metric

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

conversion_view_content_value Metric

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

conversion_view_content_view Metric

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

conversion_view_content_web Dimension

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

conversion_visit Metric

Attributed visit conversion events.

conversion_visit_app Dimension

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

conversion_visit_offline Dimension

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

conversion_visit_web Dimension

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

conversion_window Dimension

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

country Dimension

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_at Dimension

The timestamp when the entity was created.

creation_state Dimension

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

creative_clickthrough_url Dimension

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

creative_composite_properties Dimension

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

creative_id Dimension

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

creative_name Dimension

The name of the creative asset.

creative_preview_properties Dimension

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

currency ad_account_currency Dimension

The currency used for the ad account.

custom_conversion[{PLACEHOLDER}] Metric

A dynamically named custom conversion event.

custom_event_{NUM} Metric

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

custom_event_{NUM}_app Dimension

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

custom_event_{NUM}_offline Dimension

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

custom_event_{NUM}_swipe_up Metric

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

custom_event_{NUM}_value Metric

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}_view Metric

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

custom_event_{NUM}_web Dimension

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

daily_budget_micro Dimension

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

date Dimension

The specific date for which the data is reported.

day Dimension

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

delivery_constraint Dimension

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

delivery_constraint_sub_type Dimension

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

delivery_status Dimension

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

dma Dimension

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_name Dimension

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

earned_impressions Metric

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

earned_reach Metric

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

end_time Dimension

The scheduled end date and time for the advertising campaign.

experiment_id Dimension

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

frequency Metric

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

funding_source_ids Dimension

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

gross_impressions Metric

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

id Dimension

The unique identifier for the ad.

impression_goal Dimension

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

impressions Metric

The total number of times the ad was displayed.

interest_category_id Dimension

The unique identifier for a target audience interest category.

interest_category_name Dimension

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

ios_installs Metric

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

ios_installs_swipe_up Metric

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

ios_installs_view Metric

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

landing_page_views Metric

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

lifetime_budget_micro Metric

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_micro campaign_lifetime_spend_cap_micro Metric

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

max_reach_goal Dimension

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

measured_impressions Metric

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

media_cost Metric

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.

min_reach_goal Dimension

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

name Dimension

The name of the organization associated with the ad account.

native_leads Metric

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

non_viewable_impressions Metric

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

objective campaign_objective Dimension

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

objective_v2_properties Dimension

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

operating_system Dimension

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

optimization_goal Dimension

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

pacing_level Dimension

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

pacing_properties_version Metric

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_type Dimension

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

paid_impressions Metric

Impressions generated from paid placements of the ad content.

pixel_id Dimension

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

placement Dimension

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

position_impressions Metric

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

position_swipe_up_percent Metric

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

post_ad_preview_url Dimension

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

preview_creative_id creative_preview_creative_id Dimension

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

quartile_{NUM} Metric

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

reach_and_frequency_rate_micro Dimension

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

reach_and_frequency_status Dimension

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

reach_goal Dimension

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

region Dimension

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.

regulations Dimension

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

reserved_type Dimension

The type of reserved ad buy.

review_status ad_review_status Dimension

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

review_status_reason ad_review_status_reason Dimension

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

saves Metric

The number of times users saved the ad content.

screen_time_millis Metric

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

shareable creative_shareable Dimension

Indicates whether the creative content is shareable by users.

skadnetwork_properties Dimension

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

spend Metric

The total amount of money spent on the advertising campaign.

spend_EUR Metric

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

start_time Dimension

The scheduled start date and time for the advertising campaign.

status campaign_status Dimension

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

story_completes Metric

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

story_opens Metric

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

swipe_up_percent Metric

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

swipes Metric

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

takeover_slot Dimension

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_bid Dimension

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

targeting.app_install_states Dimension

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

targeting.auto_expansion_options Dimension

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

targeting.demographics Dimension

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

targeting.devices Dimension

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

targeting.enable_targeting_expansion Dimension

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

targeting.geos Dimension

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

targeting.interests Dimension

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

targeting.locations Dimension

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_spec Dimension

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

targeting.regulated_content Dimension

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

targeting.segments Dimension

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

targeting.separated_types Dimension

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

targeting_reach_status Dimension

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

timezone ad_account_timezone Dimension

The timezone configured for the ad account.

top_snap_crop_position creative_top_snap_crop_position Dimension

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

top_snap_media_id creative_top_snap_media_id Dimension

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

total_impressions Metric

The cumulative total of all impressions generated by the ad.

total_installs Metric

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

total_installs_swipe_up Metric

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

total_installs_view Metric

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

total_reach Metric

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

type ad_type Dimension

The specific type of ad creative or ad format.

uniques Metric

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

updated_at Dimension

The timestamp when the entity was last updated.

video_views Metric

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

video_views_15s Metric

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

video_views_time_based Metric

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

view_completion Metric

The percentage of users who completed viewing the ad creative.

view_time_millis Metric

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

viewable_impressions Metric

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

viewable_rate Metric

The percentage of total impressions that were considered viewable.