Snapchat Ads is currently in beta. The info in this guide is subject to change.
This integration is powered by Singer's snapchat-ads tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Snapchat Ads integration summary
Stitch’s Snapchat Ads integration replicates data using the Snapchat Ads Marketing API. Refer to the Schema section for a list of objects available for replication.
Snapchat Ads feature snapshot
A high-level look at Stitch's Snapchat Ads (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Beta |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Snapchat Ads
Step 1: Add Snapchat Ads as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Snapchat Ads icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Snapchat Ads” would create a schema called
stitch_snapchat_ads
in the destination. Note: Schema names cannot be changed after you save the integration. - If needed, set the following optional parameters:
- Omit Empty: Use this parameter to omit records for a given date or entity if there is no data for any of the metrics. The value can be
true
orfalse
. The default value istrue
. - Targeting Country Codes: Enter a comma-separated list of lowercase two-letter ISO country codes for ads targeting. The default value is
us
. - Swipe Up Attribution Window: Enter the attribution window for swipe-ups. The value can be
1_DAY
,7_DAY
, or28_DAY
. The default value is28_DAY
. - View Attribution Window: Enter the attribution window for views. The value can be
1_HOUR
,3_HOUR
,6_HOUR
,1_DAY
,7_DAY
, or28_DAY
. The default value is1_DAY
.
- Omit Empty: Use this parameter to omit records for a given date or entity if there is no data for any of the metrics. The value can be
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Snapchat Ads integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Snapchat Ads’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Snapchat Ads integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch
- Next, you’ll be prompted to log into your Snapchat account and approve Stitch’s access to your Snapchat Ads data. Note that we will only ever read your data.
- Click Authorize to connect.
- Sign in with your Snapchat account.
- After your credentials are validated, you’ll be directed back to Stitch and prompted to select the Snapchat Ads accounts you want to for which you want to run extractions.
- When finished, click Check and Save, then click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Snapchat Ads integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Snapchat Ads, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Snapchat Ads table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Snapchat Ads integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
This stream retrieves all Ads under a specified Ad account
ad_account_id
AD Account ID |
|||
ad_squad_id
AD Squad ID |
|||
created_at
Date of creation for AD |
|||
creative_id
Creative ID |
|||
id
AD ID |
|||
name
AD name |
|||
paying_advertiser_name
Name of the paying advertiser/political entity |
|||
render_type
|
|||
review_status
Ad Review Status. Example: PENDING, APPROVED, REJECTED |
|||
review_status_reasons
List of Ad Review Rejection Reasons |
|||
status
Ad status. Example: ACTIVE, PAUSED |
|||
third_party_paid_impression_tracking_urls
Third-party impression tags, executed on ad impression
|
|||
third_party_swipe_tracking_urls
Third-party swipe tags, executed on swipe of attachment
|
|||
type
Ad type. Example: SNAP_AD, LONGFORM_VIDEO, APP_INSTALL |
|||
updated_at
Date of last update |
ad_accounts
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
This stream retrieves all ad accounts for the specified Organization.
advertiser
Name of the Advertiser |
||||||||
advertiser_organization_id
Organization ID of the Advertiser selected |
||||||||
agency_client_metadata
Client metadata is required if agency_representing_client is true and if the Advertiser is based in France or is targeting Ads to audiences in France
|
||||||||
agency_representing_client
Account name |
||||||||
billing_type
Type of billing |
||||||||
client_based_in_country
Required if agency_representing_client is true and if Advertiser is based in France or targeting Ads to audiences in France |
||||||||
client_paying_invoices
Required if agency_representing_client is true and if Advertiser is based in France or targeting Ads to audiences in France |
||||||||
created_at
Date and Time at which Ad Account was created |
||||||||
currency
Account currency |
||||||||
funding_source_ids
Array of Funding Source IDs
|
||||||||
id
AD Account ID |
||||||||
lifetime_spend_cap_micro
Required if billing_type is set to IO, the lifetime spend cap of the account in micro currency |
||||||||
name
Name of the AD Account |
||||||||
organization_id
Oragnization ID |
||||||||
paying_advertiser_name
Name of the paying advertiser/political entity |
||||||||
regulations
Required if the Ad Account will contain ads for Credit, Housing or Employment, this attribute is immutable once set to true
|
||||||||
status
Delivery status |
||||||||
timezone
AD Account timezone |
||||||||
type
Account type. Example: DIRECT, PARTNER |
||||||||
updated_at
Date and Time at which Ad Account was last updated |
ad_account_stats_daily
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This endpoint retrieves the spend metric for the specified Ad Account at DAY granularity, the spend metric is the only metric available for the ad account entity
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
granularity
Metrics granularity. Example: DAY |
id
Ad Account ID |
spend
Amount Spent (micro-currency) |
start_time
Start Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups. Example: 1_DAY, 7_DAY, 28_DAY (default) |
type
AD Type |
view_attribution_window
Attribution window for views. Example: 1_HOUR, 3_HOUR, 6_HOUR, 1_DAY (default), 7_DAY, 28_DAY |
ad_account_stats_hourly
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This endpoint retrieves the spend metric for the specified Ad Account at HOUR granularity, the spend metric is the only metric available for the ad account entity
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
granularity
Metrics granularity. Example: HOUR |
id
Ad Account ID |
spend
Amount Spent (micro-currency) |
start_time
Start Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups. Example: 1_DAY, 7_DAY, 28_DAY (default) |
type
|
view_attribution_window
Attribution window for views. Example: 1_HOUR, 3_HOUR, 6_HOUR, 1_DAY (default), 7_DAY, 28_DAY |
ad_squads
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
This stream retrieves all ad squads within a specified ad account.
ad_account_id
AD Account ID |
||||||||
auto_bid
Allow Snapchat to automatically set the bid to recommended amount |
||||||||
bid_micro
Max Bid (micro-currency) |
||||||||
bid_strategy
Bidding strategy for this Ad Squad. Example: AUTO_BID, LOWEST_COST_WITH_MAX_BID, MIN_ROAS, TARGET_COST |
||||||||
billing_event
Billing Event. Example: IMPRESSION |
||||||||
campaign_id
Campaign ID |
||||||||
cap_and_exclusion_config
The frequency cap and exclusion spec |
||||||||
created_at
Date and Time at which AD Squad was created |
||||||||
daily_budget_micro
Daily Budget (micro-currency) |
||||||||
delivery_constraint
Type of delivery |
||||||||
end_time
End time |
||||||||
id
AD Squad ID |
||||||||
impression_goal
Reach goal as specified in the Forecasting request |
||||||||
lifetime_budget_micro
Lifetime budget (micro-currency) |
||||||||
name
AD Squad name |
||||||||
optimization_goal
Optimization Goal. Example: MPRESSIONS, SWIPES, APP_INSTALLS, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC, USES, STORY_OPENS, PIXEL_PAGE_VIEW, PIXEL_ADD_TO_CART, PIXEL_PURCHASE, PIXEL_SIGNUP, APP_ADD_TO_CART, APP_PURCHASE, APP_SIGNUP |
||||||||
pacing_type
Type of pacing. Example: STANDARD (default), ACCELERATED |
||||||||
pixel_id
Pixel to be associated with the Ad Squad |
||||||||
placement
|
||||||||
placement_v2
Placement, Json object containing advanced placement
|
||||||||
product_properties
Product Properties to be associated with the Ad Squad
|
||||||||
reach_and_frequency_micro
reach and frequency budget (micro-currency) |
||||||||
reach_and_frequency_status
Status of the reach and frequency booking |
||||||||
reach_goal
Reach goal as specified in the Forecasting request |
||||||||
start_time
Start Time |
||||||||
status
Ad Squad status. Example: ACTIVE, PAUSED |
||||||||
target_bid
Allows Snapchat to adjust the bid aiming to keep your average CPA at or below the amount set by the ad set end date |
||||||||
targeting
Targeting spec
|
||||||||
targeting_reach_status
Status of target reach. Example: VALID, INVALID |
||||||||
type
AD Squad type |
||||||||
updated_at
Date and Time at which AD squad was last updated |
ad_squad_stats_daily
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Ad Squad at DAY granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |
conversion_level_completes_app
|
conversion_level_completes_web
|
conversion_list_view
Number of attributed |
conversion_list_view_app
|
conversion_list_view_web
|
conversion_login
Number of attributed |
conversion_login_app
|
conversion_login_web
|
conversion_page_views
Number of attributed |
conversion_page_views_app
|
conversion_page_views_web
|
conversion_purchases
Number of attributed |
conversion_purchases_app
|
conversion_purchases_value
Value of attributed |
conversion_purchases_value_app
|
conversion_purchases_value_web
|
conversion_purchases_web
|
conversion_rate
Number of attributed |
conversion_rate_app
|
conversion_rate_web
|
conversion_reserve
Number of attributed |
conversion_reserve_app
|
conversion_reserve_web
|
conversion_save
Number of attributed |
conversion_save_app
|
conversion_save_web
|
conversion_searches
Number of attributed |
conversion_searches_app
|
conversion_searches_web
|
conversion_share
Number of attributed |
conversion_share_app
|
conversion_share_web
|
conversion_sign_ups
Number of attributed |
conversion_sign_ups_app
|
conversion_sign_ups_web
|
conversion_spend_credits
Number of attributed |
conversion_spend_credits_app
|
conversion_spend_credits_web
|
conversion_start_checkout
Number of attributed |
conversion_start_checkout_app
|
conversion_start_checkout_web
|
conversion_start_trial
Number of attributed |
conversion_start_trial_app
|
conversion_start_trial_web
|
conversion_subscribe
Number of attributed |
conversion_subscribe_app
|
conversion_subscribe_web
|
conversion_view_content
Number of attributed |
conversion_view_content_app
|
conversion_view_content_web
|
custom_event_1
Number of attributed |
custom_event_1_app
|
custom_event_1_web
|
custom_event_2
Number of attributed |
custom_event_2_app
|
custom_event_2_web
|
custom_event_3
Number of attributed |
custom_event_3_app
|
custom_event_3_web
|
custom_event_4
Number of attributed |
custom_event_4_app
|
custom_event_4_web
|
custom_event_5
Number of attributed |
custom_event_5_app
|
custom_event_5_web
|
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
frequency
Average number of Impressions per User Reached |
granularity
Metrics granularity. Example: DAY |
id
AD Squad ID |
impressions
Impression Count |
ios_installs
Number of iOS App Installs |
ios_installs_app
|
ios_installs_web
|
quartile_1
Video Views to 25% |
quartile_2
Video Views to 50% |
quartile_3
Video Views to 75% |
screen_time_millis
Total Time Spent on top Snap Ad (milliseconds) |
spend
Amount Spent (micro-currency) |
start_time
End Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups |
swipe_up_percent
|
swipes
% of Impressions that Swiped-Up |
total_installs
Total number of App Installs |
total_installs_app
|
total_installs_web
|
type
|
uniques
Number of unique impressions |
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 |
video_views_15s
The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it’s shorter than 15 seconds, or a swipe up action on the ad |
video_views_time_based
The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups |
view_attribution_window
Attribution window for views |
view_completion
Video Views to completion |
view_time_millis
Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds) |
ad_squad_stats_hourly
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Ad Squad at HOUR granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |
conversion_level_completes_app
|
conversion_level_completes_web
|
conversion_list_view
Number of attributed |
conversion_list_view_app
|
conversion_list_view_web
|
conversion_login
Number of attributed |
conversion_login_app
|
conversion_login_web
|
conversion_page_views
Number of attributed |
conversion_page_views_app
|
conversion_page_views_web
|
conversion_purchases
Number of attributed |
conversion_purchases_app
|
conversion_purchases_value
Value of attributed |
conversion_purchases_value_app
|
conversion_purchases_value_web
|
conversion_purchases_web
|
conversion_rate
Number of attributed |
conversion_rate_app
|
conversion_rate_web
|
conversion_reserve
Number of attributed |
conversion_reserve_app
|
conversion_reserve_web
|
conversion_save
Number of attributed |
conversion_save_app
|
conversion_save_web
|
conversion_searches
Number of attributed |
conversion_searches_app
|
conversion_searches_web
|
conversion_share
Number of attributed |
conversion_share_app
|
conversion_share_web
|
conversion_sign_ups
Number of attributed |
conversion_sign_ups_app
|
conversion_sign_ups_web
|
conversion_spend_credits
Number of attributed |
conversion_spend_credits_app
|
conversion_spend_credits_web
|
conversion_start_checkout
Number of attributed |
conversion_start_checkout_app
|
conversion_start_checkout_web
|
conversion_start_trial
Number of attributed |
conversion_start_trial_app
|
conversion_start_trial_web
|
conversion_subscribe
Number of attributed |
conversion_subscribe_app
|
conversion_subscribe_web
|
conversion_view_content
Number of attributed |
conversion_view_content_app
|
conversion_view_content_web
|
custom_event_1
Number of attributed |
custom_event_1_app
|
custom_event_1_web
|
custom_event_2
Number of attributed |
custom_event_2_app
|
custom_event_2_web
|
custom_event_3
Number of attributed |
custom_event_3_app
|
custom_event_3_web
|
custom_event_4
Number of attributed |
custom_event_4_app
|
custom_event_4_web
|
custom_event_5
Number of attributed |
custom_event_5_app
|
custom_event_5_web
|
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
frequency
Average number of Impressions per User Reached |
granularity
Metrics granularity. Example: HOUR |
id
AD Squad ID |
impressions
Impression Count |
ios_installs
Number of iOS App Installs |
ios_installs_app
|
ios_installs_web
|
quartile_1
Video Views to 25% |
quartile_2
Video Views to 50% |
quartile_3
Video Views to 75% |
screen_time_millis
Total Time Spent on top Snap Ad (milliseconds) |
spend
Amount Spent (micro-currency) |
start_time
End Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups |
swipe_up_percent
|
swipes
% of Impressions that Swiped-Up |
total_installs
Total number of App Installs |
total_installs_app
|
total_installs_web
|
type
|
uniques
Number of unique impressions |
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 |
video_views_15s
The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it’s shorter than 15 seconds, or a swipe up action on the ad |
video_views_time_based
The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups |
view_attribution_window
Attribution window for views |
view_completion
Video Views to completion |
view_time_millis
Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds) |
ad_stats_daily
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Ad at DAY granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |
conversion_level_completes_app
|
conversion_level_completes_web
|
conversion_list_view
Number of attributed |
conversion_list_view_app
|
conversion_list_view_web
|
conversion_login
Number of attributed |
conversion_login_app
|
conversion_login_web
|
conversion_page_views
Number of attributed |
conversion_page_views_app
|
conversion_page_views_web
|
conversion_purchases
Number of attributed |
conversion_purchases_app
|
conversion_purchases_value
Value of attributed |
conversion_purchases_value_app
|
conversion_purchases_value_web
|
conversion_purchases_web
|
conversion_rate
Number of attributed |
conversion_rate_app
|
conversion_rate_web
|
conversion_reserve
Number of attributed |
conversion_reserve_app
|
conversion_reserve_web
|
conversion_save
Number of attributed |
conversion_save_app
|
conversion_save_web
|
conversion_searches
Number of attributed |
conversion_searches_app
|
conversion_searches_web
|
conversion_share
Number of attributed |
conversion_share_app
|
conversion_share_web
|
conversion_sign_ups
Number of attributed |
conversion_sign_ups_app
|
conversion_sign_ups_web
|
conversion_spend_credits
Number of attributed |
conversion_spend_credits_app
|
conversion_spend_credits_web
|
conversion_start_checkout
Number of attributed |
conversion_start_checkout_app
|
conversion_start_checkout_web
|
conversion_start_trial
Number of attributed |
conversion_start_trial_app
|
conversion_start_trial_web
|
conversion_subscribe
Number of attributed |
conversion_subscribe_app
|
conversion_subscribe_web
|
conversion_view_content
Number of attributed |
conversion_view_content_app
|
conversion_view_content_web
|
custom_event_1
Number of attributed |
custom_event_1_app
|
custom_event_1_web
|
custom_event_2
Number of attributed |
custom_event_2_app
|
custom_event_2_web
|
custom_event_3
Number of attributed |
custom_event_3_app
|
custom_event_3_web
|
custom_event_4
Number of attributed |
custom_event_4_app
|
custom_event_4_web
|
custom_event_5
Number of attributed |
custom_event_5_app
|
custom_event_5_web
|
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
frequency
Average number of Impressions per User Reached |
granularity
Metrics granularity. Example: DAY |
id
AD Stat ID |
impressions
Impression Count |
ios_installs
Number of iOS App Installs |
ios_installs_app
|
ios_installs_web
|
quartile_1
Video Views to 25% |
quartile_2
Video Views to 50% |
quartile_3
Video Views to 75% |
screen_time_millis
Total Time Spent on top Snap Ad (milliseconds) |
spend
Amount Spent (micro-currency) |
start_time
End Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups |
swipe_up_percent
|
swipes
% of Impressions that Swiped-Up |
total_installs
Total number of App Installs |
total_installs_app
|
total_installs_web
|
type
|
uniques
Number of unique impressions |
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 |
video_views_15s
The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it’s shorter than 15 seconds, or a swipe up action on the ad |
video_views_time_based
The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups |
view_attribution_window
Attribution window for views |
view_completion
Video Views to completion |
view_time_millis
Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds) |
ad_stats_hourly
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Ad at HOUR granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |
conversion_level_completes_app
|
conversion_level_completes_web
|
conversion_list_view
Number of attributed |
conversion_list_view_app
|
conversion_list_view_web
|
conversion_login
Number of attributed |
conversion_login_app
|
conversion_login_web
|
conversion_page_views
Number of attributed |
conversion_page_views_app
|
conversion_page_views_web
|
conversion_purchases
Number of attributed |
conversion_purchases_app
|
conversion_purchases_value
Value of attributed |
conversion_purchases_value_app
|
conversion_purchases_value_web
|
conversion_purchases_web
|
conversion_rate
Number of attributed |
conversion_rate_app
|
conversion_rate_web
|
conversion_reserve
Number of attributed |
conversion_reserve_app
|
conversion_reserve_web
|
conversion_save
Number of attributed |
conversion_save_app
|
conversion_save_web
|
conversion_searches
Number of attributed |
conversion_searches_app
|
conversion_searches_web
|
conversion_share
Number of attributed |
conversion_share_app
|
conversion_share_web
|
conversion_sign_ups
Number of attributed |
conversion_sign_ups_app
|
conversion_sign_ups_web
|
conversion_spend_credits
Number of attributed |
conversion_spend_credits_app
|
conversion_spend_credits_web
|
conversion_start_checkout
Number of attributed |
conversion_start_checkout_app
|
conversion_start_checkout_web
|
conversion_start_trial
Number of attributed |
conversion_start_trial_app
|
conversion_start_trial_web
|
conversion_subscribe
Number of attributed |
conversion_subscribe_app
|
conversion_subscribe_web
|
conversion_view_content
Number of attributed |
conversion_view_content_app
|
conversion_view_content_web
|
custom_event_1
Number of attributed |
custom_event_1_app
|
custom_event_1_web
|
custom_event_2
Number of attributed |
custom_event_2_app
|
custom_event_2_web
|
custom_event_3
Number of attributed |
custom_event_3_app
|
custom_event_3_web
|
custom_event_4
Number of attributed |
custom_event_4_app
|
custom_event_4_web
|
custom_event_5
Number of attributed |
custom_event_5_app
|
custom_event_5_web
|
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
frequency
Average number of Impressions per User Reached |
granularity
Metrics granularity. Example: HOUR |
id
AD Stat ID |
impressions
Impression Count |
ios_installs
Number of iOS App Installs |
ios_installs_app
|
ios_installs_web
|
quartile_1
Video Views to 25% |
quartile_2
Video Views to 50% |
quartile_3
Video Views to 75% |
screen_time_millis
Total Time Spent on top Snap Ad (milliseconds) |
spend
Amount Spent (micro-currency) |
start_time
End Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups |
swipe_up_percent
|
swipes
% of Impressions that Swiped-Up |
total_installs
Total number of App Installs |
total_installs_app
|
total_installs_web
|
type
|
uniques
Number of unique impressions |
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 |
video_views_15s
The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it’s shorter than 15 seconds, or a swipe up action on the ad |
video_views_time_based
The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups |
view_attribution_window
Attribution window for views |
view_completion
Video Views to completion |
view_time_millis
Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds) |
audience_segments
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
This stream retrieves all Customer List segments within a specified ad account.
ad_account_id
Ad Account ID |
approximate_number_users
Approximate number of users in the segment |
created_at
Date of creation |
description
Audience Segment Description |
id
Segment ID |
name
Segment Name |
organization_id
Organization ID |
retention_in_days
Number of days to retain audience members |
source_type
Data source type |
status
Status of the segment |
targetable_status
Status of whether this segment can be targeted |
updated_at
Date of last update |
upload_status
Upload status of the segment |
visible_to
|
billing_centers
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
Billing Centers allow Businesses to have multiple invoicing locations to choose from. A Billing Center is the contact that will be receiving invoices.
address_line_1
Address line 1 |
administrative_district_level_1
District |
alternative_email_addresses
Array of email addresses |
country
Country |
created_at
Date of creation |
email_address
Email address |
id
Billing Center ID |
locality
Locality name |
name
Billing center name |
organization_id
Organization ID |
postal_code
Post code |
updated_at
Date and Time at which the billing center was last updated |
campaigns
Replication Method : |
Key-based Incremental |
Replication Key |
updated_at |
Primary Key |
id |
Official docs : |
This stream retrieves all campaigns within a specified ad account
ad_account_id
Ad Account ID |
buy_model
Buy Model. Example: AUCTION(default), RESERVED |
created_at
Date of creation |
daily_budget_micro
Daily Spend Cap (micro-currency) |
end_time
End time of the Campaign |
id
Campaign ID |
lifetime_spend_cap_micro
Lifetime spend cap for the campaign (microcurrency) |
measurement_spec
The apps to be tracked for this campaign |
name
Campaign name |
objective
Objective of the Campaign. Default: BRAND_AWARENESS |
regulations
Required for Campaigns that run Ads for Credit, Housing, Employment (CHE) |
start_time
Start Time of Campaign |
status
Campaign status |
updated_at
Date of last updated |
campaign_stats_daily
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Campaign at DAY granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |
conversion_level_completes_app
|
conversion_level_completes_web
|
conversion_list_view
Number of attributed |
conversion_list_view_app
|
conversion_list_view_web
|
conversion_login
Number of attributed |
conversion_login_app
|
conversion_login_web
|
conversion_page_views
Number of attributed |
conversion_page_views_app
|
conversion_page_views_web
|
conversion_purchases
Number of attributed |
conversion_purchases_app
|
conversion_purchases_value
Value of attributed |
conversion_purchases_value_app
|
conversion_purchases_value_web
|
conversion_purchases_web
|
conversion_rate
Number of attributed |
conversion_rate_app
|
conversion_rate_web
|
conversion_reserve
Number of attributed |
conversion_reserve_app
|
conversion_reserve_web
|
conversion_save
Number of attributed |
conversion_save_app
|
conversion_save_web
|
conversion_searches
Number of attributed |
conversion_searches_app
|
conversion_searches_web
|
conversion_share
Number of attributed |
conversion_share_app
|
conversion_share_web
|
conversion_sign_ups
Number of attributed |
conversion_sign_ups_app
|
conversion_sign_ups_web
|
conversion_spend_credits
Number of attributed |
conversion_spend_credits_app
|
conversion_spend_credits_web
|
conversion_start_checkout
Number of attributed |
conversion_start_checkout_app
|
conversion_start_checkout_web
|
conversion_start_trial
Number of attributed |
conversion_start_trial_app
|
conversion_start_trial_web
|
conversion_subscribe
Number of attributed |
conversion_subscribe_app
|
conversion_subscribe_web
|
conversion_view_content
Number of attributed |
conversion_view_content_app
|
conversion_view_content_web
|
custom_event_1
Number of attributed |
custom_event_1_app
|
custom_event_1_web
|
custom_event_2
Number of attributed |
custom_event_2_app
|
custom_event_2_web
|
custom_event_3
Number of attributed |
custom_event_3_app
|
custom_event_3_web
|
custom_event_4
Number of attributed |
custom_event_4_app
|
custom_event_4_web
|
custom_event_5
Number of attributed |
custom_event_5_app
|
custom_event_5_web
|
end_time
End Time (ISO 8601) |
finalized_data_end_time
This attribute defines the time up until when non-conversion reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the finalized_data_end_time the metrics are still undergoing de-duplication and finalization and may change accordingly |
frequency
Average number of Impressions per User Reached |
granularity
Metrics granularity. Example: DAY |
id
Campaign ID |
impressions
Impression Count |
ios_installs
Number of iOS App Installs |
ios_installs_app
|
ios_installs_web
|
quartile_1
Video Views to 25% |
quartile_2
Video Views to 50% |
quartile_3
Video Views to 75% |
screen_time_millis
Total Time Spent on top Snap Ad (milliseconds) |
spend
Amount Spent (micro-currency) |
start_time
End Time (ISO 8601) |
swipe_up_attribution_window
Attribution window for swipe ups |
swipe_up_percent
|
swipes
% of Impressions that Swiped-Up |
total_installs
Total number of App Installs |
total_installs_app
|
total_installs_web
|
type
|
uniques
Number of unique impressions |
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 |
video_views_15s
The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it’s shorter than 15 seconds, or a swipe up action on the ad |
video_views_time_based
The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups |
view_attribution_window
Attribution window for views |
view_completion
Video Views to completion |
view_time_millis
Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds) |
campaign_stats_hourly
Replication Method : |
Key-based Incremental |
Replication Key |
end_time |
Primary Key |
id : start_time |
Official docs : |
This stream retrieves stats for the specified Campaign at HOUR granularity
android_installs
Number of Android App Installs |
android_installs_app
|
android_installs_web
|
attachment_avg_view_time_millis
Average Attachment View Time (milli-seconds) |
attachment_frequency
Average number of Attachment Views per User Reached |
attachment_impressions
|
attachment_quartile_1
Long Form Video Views to 25% |
attachment_quartile_2
Long Form Video Views to 50% |
attachment_quartile_3
Long Form Video Views to 75% |
attachment_total_view_time_millis
Total Attachment View Time (milli-seconds) |
attachment_uniques
Number of unique attachment impressions |
attachment_view_completion
Long Form Video Views to completion |
avg_screen_time_millis
Average Top Snap view time across all impressions |
avg_view_time_millis
Use avg_screen_time_millis instead. Average Top Snap view time per User Reached |
conversion_achievement_unlocked
Number of attributed |
conversion_achievement_unlocked_app
|
conversion_achievement_unlocked_web
|
conversion_ad_click
Number of attributed |
conversion_ad_click_app
|
conversion_ad_click_web
|
conversion_ad_view
Number of attributed |
conversion_ad_view_app
|
conversion_ad_view_web
|
conversion_add_billing
Number of attributed |
conversion_add_billing_app
|
conversion_add_billing_web
|
conversion_add_cart
Number of attributed |
conversion_add_cart_app
|
conversion_add_cart_web
|
conversion_add_to_wishlist
Number of attributed |
conversion_add_to_wishlist_app
|
conversion_add_to_wishlist_web
|
conversion_app_opens
Number of attributed |
conversion_app_opens_app
|
conversion_app_opens_web
|
conversion_complete_tutorial
Number of attributed |
conversion_complete_tutorial_app
|
conversion_complete_tutorial_web
|
conversion_invite
Number of attributed |
conversion_invite_app
|
conversion_invite_web
|
conversion_level_completes
Number of attributed |