Snapchat Datasource

Vendor/Partner	Snapchat
Version	`v1`
API Documentation	https://marketingapi.snapchat.com/docs/#version
Sunset Date	None as of 10/06/2023 https://marketingapi.snapchat.com/docs/#version
Channel(s)
Refresh Time (CST)	7am
Default backfill	29 Days
Alli Data Library

Getting Started

Select the Ad Account that you would like to run a report on.

Limitations

Backfilling

When backfilling data that's more than a month, the job will be split into multiple jobs. Therefore, you will have to wait until all of them are done to get all of the results that you want.

Timezones

Snapchat gets each ad account’s specific timezone to use in the report from an endpoint that supplies account information.

Quotas

Snapchat doesn’t give specific numbers to the rate limits. The only information they can give are the names and types of the header whenever you hit the limit: https://developers.snapchat.com/api/docs/#rate-limits

Selectable Accounts

Accounts that show up after authentication does not guarantee access to the client. This datasource does NOT check whether the user the necessary access to request data from Snap. Below is an example of a permission related error:

CODE

None of the requested actions [READ_CONTAINER_ENTITY, READ_AD] can be authorized. Current user principal: 489aad24-1207-4672-be7d-a1bde5a53026. Container roles: [member, audience]"

Define your Data

Dimensions

Name	Type	Table Field Name	Description
Campaign Name	string	campaignName	Unique name of the campaign
Campaign ID	string	campaignId	Unique alphanumerical ID of the campaign
Adsquad Name	string	adsquadName	Unique name of the ad squad
Adsquad ID	string	adsquadId	Unique alphanumerical ID of the adsquad
Ad Name	string	adName	Unique name of the ad
Ad ID	string	adId	Unique alphanumerical ID of the Ad
Date	date	date	The date of when the metrics were snapshot

Metrics

Name	Type	Table Field Name	Description
Impressions	number	impressions	Impression Count
Swipes	number	swipes	Swipe-Up Count
View Time (milliseconds)	number	view_time_millis	Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds)
Screen Time (milliseconds)	number	screen_time_millis	Total Time Spent on top Snap Ad (milliseconds)
Quartile 1	number	quartile_1	Video Views to 25%
Quartile 2	number	quartile_2	Video Views to 50%
Quartile 3	number	quartile_3	Video Views to 75%
View Completion	number	view_completion	Video Views to completion
Spend	number	spend	Amount Spent (micro-currency)
Video Views	number	video_views	The 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

Endpoints

Get all organizations that your account has access to:
- https://developers.snapchat.com/api/docs/#organizations
Get all ad accounts for each organization:
- https://developers.snapchat.com/api/docs/#get-all-ad-accounts
Get all campaigns under ad account:
- https://developers.snapchat.com/api/docs/#get-all-campaigns
Get all ad squads under ad account:
- https://developers.snapchat.com/api/docs/#get-all-ad-squads-under-an-ad-account
Get all ads under ad account:
- https://developers.snapchat.com/api/docs/#get-all-ads-under-an-ad-account
Get specific campaign:
- https://developers.snapchat.com/api/docs/#get-a-specific-campaign
Get specific ad squad:
- https://developers.snapchat.com/api/docs/#get-a-specific-ad-squad
Get specific ad:
- https://developers.snapchat.com/api/docs/#get-a-specific-ad
Get stats for an entity:
- https://developers.snapchat.com/api/docs/#measurement