Snapchat Ads Connector Reference

72 metrics50 dimensions

 

https://connectors.windsor.ai/snapchat?api_key=[your API key]&date_preset=last_7d&fields=campaign,clicks,spend,impressions,date,source&_renderer=csv

The Snapchat Ads connector exposes 122 fields (72 metrics, 50 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Available options


swipe_up_attribution_window Click Attribution Window

Attribution window for swipe ups

Possible values (3)
1_DAY7_DAY28_DAYdefault
view_attribution_window View Attribution Window

Attribution window for views

Possible values (6)
none1_HOUR3_HOUR6_HOUR1_DAYdefault7_DAY
action_report_time Action Report Time

Report conversions by the time of the conversion event or by the time of the attributed ad impression (Snapchat Ads Manager reports by impression time)

Possible values (2)
conversiondefaultimpression

Snapchat Ads Fields

Snapchat Ads report_dimension fields

The report_dimension report of the Snapchat Ads connector includes 8 fields.

IDTypeNameDescription
ageTEXTAgeAge buckets (Report dimension)
countryCOUNTRYCountryCountry (Report dimension)
dmaTEXTDMADMA (Report dimension)
genderTEXTGenderGender (Report dimension)
lifestyle_categoryTEXTSnapchat Lifestyle CategorySnapchat Lifestyle Category (Report dimension)
makeTEXTDevice MakeDevice Make (Report dimension)
osTEXTOsOperating System (Report dimension)
regionREGIONRegionRegion (Report dimension)

Snapchat Ads other fields

The Snapchat Ads connector has 114 fields that do not belong to a named report, or belong to a report with only one or two fields.

Snapchat Ads other fields (account_id to conversion_purchases_value)

IDTypeNameDescriptionReport
account_idTEXTAccount IDSnapchat Ads advertiser ID.
account_nameTEXTAccount NameSnapchat Ads advertiser name.
ad_idTEXTAd IDAd ID
ad_nameTEXTAd NameAd name
ad_squad_daily_budgetNUMERICAd Squad Daily BudgetAd squad daily budget
ad_squad_delivery_statusTEXTAd Squad Delivery StatusOperational delivery status of the ad squad (e.g. ACTIVE, PAUSED, INVALID_END_TIME); comma-joined when the API returns multiple.
ad_squad_end_dateDATEAd Squad End DateAd squad end time (ISO 8601 datetime); empty for open-ended ad squads
ad_squad_idTEXTAd Squad IDAd squad ID
ad_squad_lifetime_budgetNUMERICAd Squad Lifetime BudgetAd squad lifetime budget
ad_squad_nameTEXTAd Squad NameAd squad name
ad_squad_optimization_goalTEXTAd Squad Optimization GoalAd squad optimization goal
ad_squad_start_dateDATEAd Squad Start DateAd squad start time (ISO 8601 datetime)
ad_squad_statusTEXTAd Squad StatusAd squad status
ad_squad_typeTEXTAd Squad TypeAd squad type
adnetwork_conversionsNUMERICAd Network ConversionsAd network reported conversions (alias for Purchases)
adnetwork_revenueNUMERICAd Network RevenueAd network reported revenue (alias for Purchase Value)
android_installsNUMERICAndroid InstallsNumber of app installs on the Android platform
campaignTEXTCampaignCampaign name
campaign_delivery_statusTEXTCampaign Delivery StatusOperational delivery status of the campaign (e.g. ACTIVE, PAUSED, INVALID_END_TIME); comma-joined when the API returns multiple.
campaign_end_dateDATECampaign End DateCampaign end time (ISO 8601 datetime); empty for open-ended campaigns
campaign_idTEXTCampaign IDCampaign ID
campaign_start_dateDATECampaign Start DateCampaign start time (ISO 8601 datetime)
campaign_statusTEXTCampaign StatusCampaign status
clicksNUMERICClicksNumber of ad clicks (alias for Ad Click)
conversion_achievement_unlockedNUMERICAchievement Unlocked (Conversion Event)Number of attributed "ACHIEVEMENT_UNLOCKED" conversion events
conversion_ad_clickNUMERICAd Click (Conversion Event)Number of attributed "AD_CLICK" conversion events
conversion_ad_viewNUMERICAd View (Conversion Event)Number of attributed "AD_VIEW" conversion events
conversion_add_billingNUMERICAdd Billing (Conversion Event)Number of attributed "ADD_BILLING" conversion events
conversion_add_cartNUMERICAdd to Cart (Conversion Event)Number of attributed "ADD_CART" conversion events
conversion_add_cart_valueNUMERICAdd to Cart Value (Conversion Event)Value of attributed "ADD_CART" conversion events (in Ad Account’s currency).
conversion_add_to_wishlistNUMERICAdd to Wishlist (Conversion Event)Number of attributed "ADD_TO_WISHLIST" conversion events
conversion_app_opensNUMERICApp Open (Conversion Event)Number of attributed "APP_OPEN" conversion events
conversion_complete_tutorialNUMERICComplete Tutorial (Conversion Event)Number of attributed "COMPLETE_TUTORIAL" conversion events
conversion_inviteNUMERICInvite (Conversion Event)Number of attributed "INVITE" conversion events
conversion_level_completesNUMERICLevel Complete (Conversion Event)Number of attributed "LEVEL_COMPLETE" conversion events
conversion_list_viewNUMERICList View (Conversion Event)Number of attributed "LIST_VIEW" conversion events
conversion_loginNUMERICLogin (Conversion Event)Number of attributed "LOGIN" conversion events
conversion_page_viewsNUMERICPage View (Conversion Event)Number of attributed "PAGE_VIEW" conversion events
conversion_purchasesNUMERICPurchases (Conversion Event)Number of attributed "PURCHASE" conversion events
conversion_purchases_valueNUMERICPurchase ValueValue of attributed "PURCHASE" conversion events (in Ad Account’s currency)

Snapchat Ads other fields (conversion_purchases_value_web to native_leads)

IDTypeNameDescriptionReport
conversion_purchases_value_webNUMERICPurchases Value WebValue of web-attributed "PURCHASE" conversion events (in Ad Account’s currency).
conversion_purchases_webNUMERICPurchases WebNumber of web-attributed "PURCHASE" conversion events.
conversion_ratePERCENTRate (Conversion Event)Number of attributed "RATE" conversion events
conversion_reserveNUMERICReserve (Conversion Event)Number of attributed "RESERVE" conversion events
conversion_saveNUMERICSave (Conversion Event)Number of attributed "SAVE" conversion events
conversion_searchesNUMERICSearch (Conversion Event)Number of attributed "SEARCH" conversion events
conversion_shareNUMERICShare (Conversion Event)Number of attributed "SHARE" conversion events
conversion_sign_upsNUMERICSign Up (Conversion Event)Number of attributed "SIGN_UP" conversion events
conversion_sign_ups_valueNUMERICSign Up Value (Conversion Event)Value of attributed "SIGN_UP" conversion events (in Ad Account’s currency).
conversion_spend_creditsNUMERICSpent Credits (Conversion Event)Number of attributed "SPENT_CREDITS" conversion events
conversion_start_checkoutNUMERICStart Checkout (Conversion Event)Number of attributed "START_CHECKOUT" conversion events
conversion_start_checkout_valueNUMERICStart Checkout Value (Conversion Event)Value of attributed "START_CHECKOUT" conversion events (in Ad Account’s currency).
conversion_start_trialNUMERICStart Trial (Conversion Event)Number of attributed "START_TRIAL" conversion events
conversion_subscribeNUMERICSubscribe(Conversion Event)Number of attributed "SUBSCRIBE" conversion events
conversion_subscribe_valueNUMERICSubscribe Value (Conversion Event)Value of attributed "SUBSCRIBE" conversion events (in Ad Account’s currency).
conversion_view_contentNUMERICView Content (Conversion Event)Number of attributed "VIEW_CONTENT" conversion events
conversion_view_content_valueNUMERICView Content Value (Conversion Event)Value of attributed "VIEW_CONTENT" conversion events (in Ad Account’s currency).
conversion_visitNUMERICVisit (Conversion Event)Number of attributed "VISIT" conversion events
cpcNUMERICCPCThe spend per click.
cpmNUMERICCPMCost per thousand impressions
creative_idTEXTCreative IDID of the creative attached to the ad; use it to build a creative preview link.
creative_media_urlTEXTCreative Media URLTop-snap creative asset download URL; an image for image creatives and the video file for video creatives.
ctrPERCENTCTRClick-through rate
currencyTEXTCurrencyAd Account currency
custom_event_1NUMERICCustom Event 1 (Conversion Event)Number of attributed "CUSTOM_EVENT_1" conversion events
custom_event_2NUMERICCustom Event 2 (Conversion Event)Number of attributed "CUSTOM_EVENT_2" conversion events
custom_event_3NUMERICCustom Event 3 (Conversion Event)Number of attributed "CUSTOM_EVENT_3" conversion events
custom_event_4NUMERICCustom Event 4 (Conversion Event)Number of attributed "CUSTOM_EVENT_4" conversion events
custom_event_5NUMERICCustom Event 5 (Conversion Event)Number of attributed "CUSTOM_EVENT_5" conversion events
data_fetched_atTIMESTAMPData fetched atUTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateDate
day_of_monthTEXTDay of monthDay of the month
earned_impressionsNUMERICEarned ImpressionsThe number of times your ad was viewed after being shared by a Snapchatter via Chat or Stories
frequencyNUMERICFrequencyThe Average number of Impressions per User Reached.
impressionsNUMERICImpressionsNumber of impressions
ios_installsNUMERICiOS InstallsNumber of app installs on the iOS platform
landing_page_viewsNUMERICLanding Page Views (Duplicate)Total number of times a user loaded the ad's landing page after a click.
monthTEXTMonthNumber of the month
native_leadsNUMERICNative LeadsTotal number of Snapchat users that swipe up, fill out the required fields, and hit ‘Submit’ on Lead Form attachments. If a user swipes down or cancels before hitting 'Submit,' this action is not counted

Snapchat Ads other fields (now to year_week_iso)

IDTypeNameDescriptionReport
nowTIMESTAMPNowCurrent timestamp
objectiveTEXTObjectiveThe Objective of the campaign
NUMERICImpressions (Paid)The total number of times your ad was served to a Snapchatter. Tracked when the ad fully renders on a device for the first time during a Snapchatter’s viewing session.
quartile_1NUMERICVideo Views to 25%Video views to 25%
quartile_2NUMERICVideo Views to 50%Video views to 50%
quartile_3NUMERICVideo Views to 75%Video views to 75%
screen_time_millisNUMERICTime Spent (milliseconds)Total time spent on top Snap ad (milliseconds)
sourceTEXTSourceThe name of the Windsor connector returning the row
spendNUMERICSpendAmount of money spent
swipe_up_percentPERCENTSwipe Up RateThe Swipe Up Rate
swipesNUMERICSwipe UpsNumber of swipes
thumbnail_urlIMAGE_URLThumbnail URLThumbnail image URL for the ad's top snap media. For video media this is a signed link that expires after ~24 hours; image media use the image file URL.
todayDATETodayToday's date
total_impressionsNUMERICTotal ImpressionsThe total number of impressions (Paid and Earned).
total_installsNUMERICTotal InstallsTotal number of app installs
total_reachNUMERICTotal ReachThe number of unique Snapchatters who viewed your Lens ad, either by receiving a Paid or Earned Impression.
totalcostNUMERICTotal CostAmount of money spent (alias for Spend)
transactionrevenueNUMERICTransaction RevenueTransaction revenue (alias for Purchase Value)
transactionsNUMERICTransactionsNumber of transactions (alias for Purchases)
uniquesNUMERICUniqueNumber of unique impressions.
video_viewsNUMERICVideo ViewsTotal number of impressions that meet the qualifying video view criteria of at least 2 seconds of consecutive watch time or a swipe up action on the Top Snap
video_views_time_basedNUMERICVideo Views (View Time Only)Total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups
view_completionNUMERICVideo Views to CompletionVideo views to completion
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20