Snapchat Ads Connector Reference

72 metrics50 dimensions

Fields Options

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.

ID	Type	Name	Description
age	TEXT	Age	Age buckets (Report dimension)
country	COUNTRY	Country	Country (Report dimension)
dma	TEXT	DMA	DMA (Report dimension)
gender	TEXT	Gender	Gender (Report dimension)
lifestyle_category	TEXT	Snapchat Lifestyle Category	Snapchat Lifestyle Category (Report dimension)
make	TEXT	Device Make	Device Make (Report dimension)
os	TEXT	Os	Operating System (Report dimension)
region	REGION	Region	Region (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)

ID	Type	Name	Description
account_id	TEXT	Account ID	Snapchat Ads advertiser ID.
account_name	TEXT	Account Name	Snapchat Ads advertiser name.
ad_id	TEXT	Ad ID	Ad ID
ad_name	TEXT	Ad Name	Ad name
ad_squad_daily_budget	NUMERIC	Ad Squad Daily Budget	Ad squad daily budget
ad_squad_delivery_status	TEXT	Ad Squad Delivery Status	Operational delivery status of the ad squad (e.g. ACTIVE, PAUSED, INVALID_END_TIME); comma-joined when the API returns multiple.
ad_squad_end_date	DATE	Ad Squad End Date	Ad squad end time (ISO 8601 datetime); empty for open-ended ad squads
ad_squad_id	TEXT	Ad Squad ID	Ad squad ID
ad_squad_lifetime_budget	NUMERIC	Ad Squad Lifetime Budget	Ad squad lifetime budget
ad_squad_name	TEXT	Ad Squad Name	Ad squad name
ad_squad_optimization_goal	TEXT	Ad Squad Optimization Goal	Ad squad optimization goal
ad_squad_start_date	DATE	Ad Squad Start Date	Ad squad start time (ISO 8601 datetime)
ad_squad_status	TEXT	Ad Squad Status	Ad squad status
ad_squad_type	TEXT	Ad Squad Type	Ad squad type
adnetwork_conversions	NUMERIC	Ad Network Conversions	Ad network reported conversions (alias for Purchases)
adnetwork_revenue	NUMERIC	Ad Network Revenue	Ad network reported revenue (alias for Purchase Value)
android_installs	NUMERIC	Android Installs	Number of app installs on the Android platform
campaign	TEXT	Campaign	Campaign name
campaign_delivery_status	TEXT	Campaign Delivery Status	Operational delivery status of the campaign (e.g. ACTIVE, PAUSED, INVALID_END_TIME); comma-joined when the API returns multiple.
campaign_end_date	DATE	Campaign End Date	Campaign end time (ISO 8601 datetime); empty for open-ended campaigns
campaign_id	TEXT	Campaign ID	Campaign ID
campaign_start_date	DATE	Campaign Start Date	Campaign start time (ISO 8601 datetime)
campaign_status	TEXT	Campaign Status	Campaign status
clicks	NUMERIC	Clicks	Number of ad clicks (alias for Ad Click)
conversion_achievement_unlocked	NUMERIC	Achievement Unlocked (Conversion Event)	Number of attributed "ACHIEVEMENT_UNLOCKED" conversion events
conversion_ad_click	NUMERIC	Ad Click (Conversion Event)	Number of attributed "AD_CLICK" conversion events
conversion_ad_view	NUMERIC	Ad View (Conversion Event)	Number of attributed "AD_VIEW" conversion events
conversion_add_billing	NUMERIC	Add Billing (Conversion Event)	Number of attributed "ADD_BILLING" conversion events
conversion_add_cart	NUMERIC	Add to Cart (Conversion Event)	Number of attributed "ADD_CART" conversion events
conversion_add_cart_value	NUMERIC	Add to Cart Value (Conversion Event)	Value of attributed "ADD_CART" conversion events (in Ad Account’s currency).
conversion_add_to_wishlist	NUMERIC	Add to Wishlist (Conversion Event)	Number of attributed "ADD_TO_WISHLIST" conversion events
conversion_app_opens	NUMERIC	App Open (Conversion Event)	Number of attributed "APP_OPEN" conversion events
conversion_complete_tutorial	NUMERIC	Complete Tutorial (Conversion Event)	Number of attributed "COMPLETE_TUTORIAL" conversion events
conversion_invite	NUMERIC	Invite (Conversion Event)	Number of attributed "INVITE" conversion events
conversion_level_completes	NUMERIC	Level Complete (Conversion Event)	Number of attributed "LEVEL_COMPLETE" conversion events
conversion_list_view	NUMERIC	List View (Conversion Event)	Number of attributed "LIST_VIEW" conversion events
conversion_login	NUMERIC	Login (Conversion Event)	Number of attributed "LOGIN" conversion events
conversion_page_views	NUMERIC	Page View (Conversion Event)	Number of attributed "PAGE_VIEW" conversion events
conversion_purchases	NUMERIC	Purchases (Conversion Event)	Number of attributed "PURCHASE" conversion events
conversion_purchases_value	NUMERIC	Purchase Value	Value of attributed "PURCHASE" conversion events (in Ad Account’s currency)

Snapchat Ads other fields (conversion_purchases_value_web to native_leads)

ID	Type	Name	Description
conversion_purchases_value_web	NUMERIC	Purchases Value Web	Value of web-attributed "PURCHASE" conversion events (in Ad Account’s currency).
conversion_purchases_web	NUMERIC	Purchases Web	Number of web-attributed "PURCHASE" conversion events.
conversion_rate	PERCENT	Rate (Conversion Event)	Number of attributed "RATE" conversion events
conversion_reserve	NUMERIC	Reserve (Conversion Event)	Number of attributed "RESERVE" conversion events
conversion_save	NUMERIC	Save (Conversion Event)	Number of attributed "SAVE" conversion events
conversion_searches	NUMERIC	Search (Conversion Event)	Number of attributed "SEARCH" conversion events
conversion_share	NUMERIC	Share (Conversion Event)	Number of attributed "SHARE" conversion events
conversion_sign_ups	NUMERIC	Sign Up (Conversion Event)	Number of attributed "SIGN_UP" conversion events
conversion_sign_ups_value	NUMERIC	Sign Up Value (Conversion Event)	Value of attributed "SIGN_UP" conversion events (in Ad Account’s currency).
conversion_spend_credits	NUMERIC	Spent Credits (Conversion Event)	Number of attributed "SPENT_CREDITS" conversion events
conversion_start_checkout	NUMERIC	Start Checkout (Conversion Event)	Number of attributed "START_CHECKOUT" conversion events
conversion_start_checkout_value	NUMERIC	Start Checkout Value (Conversion Event)	Value of attributed "START_CHECKOUT" conversion events (in Ad Account’s currency).
conversion_start_trial	NUMERIC	Start Trial (Conversion Event)	Number of attributed "START_TRIAL" conversion events
conversion_subscribe	NUMERIC	Subscribe(Conversion Event)	Number of attributed "SUBSCRIBE" conversion events
conversion_subscribe_value	NUMERIC	Subscribe Value (Conversion Event)	Value of attributed "SUBSCRIBE" conversion events (in Ad Account’s currency).
conversion_view_content	NUMERIC	View Content (Conversion Event)	Number of attributed "VIEW_CONTENT" conversion events
conversion_view_content_value	NUMERIC	View Content Value (Conversion Event)	Value of attributed "VIEW_CONTENT" conversion events (in Ad Account’s currency).
conversion_visit	NUMERIC	Visit (Conversion Event)	Number of attributed "VISIT" conversion events
cpc	NUMERIC	CPC	The spend per click.
cpm	NUMERIC	CPM	Cost per thousand impressions
creative_id	TEXT	Creative ID	ID of the creative attached to the ad; use it to build a creative preview link.
creative_media_url	TEXT	Creative Media URL	Top-snap creative asset download URL; an image for image creatives and the video file for video creatives.
ctr	PERCENT	CTR	Click-through rate
currency	TEXT	Currency	Ad Account currency
custom_event_1	NUMERIC	Custom Event 1 (Conversion Event)	Number of attributed "CUSTOM_EVENT_1" conversion events
custom_event_2	NUMERIC	Custom Event 2 (Conversion Event)	Number of attributed "CUSTOM_EVENT_2" conversion events
custom_event_3	NUMERIC	Custom Event 3 (Conversion Event)	Number of attributed "CUSTOM_EVENT_3" conversion events
custom_event_4	NUMERIC	Custom Event 4 (Conversion Event)	Number of attributed "CUSTOM_EVENT_4" conversion events
custom_event_5	NUMERIC	Custom Event 5 (Conversion Event)	Number of attributed "CUSTOM_EVENT_5" conversion events
data_fetched_at	TIMESTAMP	Data fetched at	UTC 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.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
date	DATE	Date	Date
day_of_month	TEXT	Day of month	Day of the month
earned_impressions	NUMERIC	Earned Impressions	The number of times your ad was viewed after being shared by a Snapchatter via Chat or Stories
frequency	NUMERIC	Frequency	The Average number of Impressions per User Reached.
impressions	NUMERIC	Impressions	Number of impressions
ios_installs	NUMERIC	iOS Installs	Number of app installs on the iOS platform
landing_page_views	NUMERIC	Landing Page Views (Duplicate)	Total number of times a user loaded the ad's landing page after a click.
month	TEXT	Month	Number of the month
native_leads	NUMERIC	Native Leads	Total 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)

ID	Type	Name	Description
now	TIMESTAMP	Now	Current timestamp
objective	TEXT	Objective	The Objective of the campaign
paid_impressions	NUMERIC	Impressions (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_1	NUMERIC	Video Views to 25%	Video views to 25%
quartile_2	NUMERIC	Video Views to 50%	Video views to 50%
quartile_3	NUMERIC	Video Views to 75%	Video views to 75%
screen_time_millis	NUMERIC	Time Spent (milliseconds)	Total time spent on top Snap ad (milliseconds)
source	TEXT	Source	The name of the Windsor connector returning the row
spend	NUMERIC	Spend	Amount of money spent
swipe_up_percent	PERCENT	Swipe Up Rate	The Swipe Up Rate
swipes	NUMERIC	Swipe Ups	Number of swipes
thumbnail_url	IMAGE_URL	Thumbnail URL	Thumbnail 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.
today	DATE	Today	Today's date
total_impressions	NUMERIC	Total Impressions	The total number of impressions (Paid and Earned).
total_installs	NUMERIC	Total Installs	Total number of app installs
total_reach	NUMERIC	Total Reach	The number of unique Snapchatters who viewed your Lens ad, either by receiving a Paid or Earned Impression.
totalcost	NUMERIC	Total Cost	Amount of money spent (alias for Spend)
transactionrevenue	NUMERIC	Transaction Revenue	Transaction revenue (alias for Purchase Value)
transactions	NUMERIC	Transactions	Number of transactions (alias for Purchases)
uniques	NUMERIC	Unique	Number of unique impressions.
video_views	NUMERIC	Video Views	Total 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_based	NUMERIC	Video 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_completion	NUMERIC	Video Views to Completion	Video views to completion
week	TEXT	Week	Week (Sun-Sat).
week_day	TEXT	Day of week and day number	Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso	TEXT	Day of week and day number, ISO	Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso	TEXT	Week ISO	Week, ISO format (Mon-Sun).
year	TEXT	Year	Year
year_month	TEXT	Yearmonth	Year and month, e.g. 2024\|3
year_month_name	TEXT	Year month name	Year and month with the month name written out, e.g. "Jan 2025".
year_of_week	TEXT	Year of week	The year that contains first day of the week (Sun-Sat).
year_of_week_iso	TEXT	Year of week, ISO	The year that contains first day of the ISO week (Mon-Sun).
year_week	TEXT	Year week	Year and week for US weeks (Sun-Sat), e.g. 2024\|15
year_week_iso	TEXT	Year week ISO	Year and week for ISO weeks (Mon-Sun), e.g. 2024\|20

API Connectors