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

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-snapchat-ads

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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Snapchat Ads icon.

  4. 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.

  5. 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 or false. The default value is true.
    • 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, or 28_DAY. The default value is 28_DAY.
    • View Attribution Window: Enter the attribution window for views. The value can be 1_HOUR, 3_HOUR, 6_HOUR, 1_DAY, 7_DAY, or 28_DAY. The default value is 1_DAY.

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:

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

  1. 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.
  2. Click Authorize to connect.
  3. Sign in with your Snapchat account.
  4. 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.
  5. 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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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

Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

Official docs :

Official Docs

This stream retrieves all Ads under a specified Ad account

ad_account_id
STRING

AD Account ID

ad_squad_id
STRING

AD Squad ID

created_at
DATE-TIME

Date of creation for AD

creative_id
STRING

Creative ID

id
STRING

AD ID

name
STRING

AD name

paying_advertiser_name
STRING

Name of the paying advertiser/political entity

render_type
STRING

review_status
STRING

Ad Review Status. Example: PENDING, APPROVED, REJECTED

review_status_reasons
ARRAY

List of Ad Review Rejection Reasons

items
STRING

ads (table), review_status_reasons (attribute)

status
STRING

Ad status. Example: ACTIVE, PAUSED

third_party_paid_impression_tracking_urls
ARRAY

Third-party impression tags, executed on ad impression

tracking_url_metadata
OBJECT

expanded_tracking_url
STRING

tracking_url
STRING

ads (table), third_party_paid_impression_tracking_urls (attribute)

third_party_swipe_tracking_urls
ARRAY

Third-party swipe tags, executed on swipe of attachment

tracking_url_metadata
OBJECT

expanded_tracking_url
STRING

tracking_url
STRING

ads (table), third_party_swipe_tracking_urls (attribute)

type
STRING

Ad type. Example: SNAP_AD, LONGFORM_VIDEO, APP_INSTALL

updated_at
DATE-TIME

Date of last update


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

Official docs :

Official Docs

This stream retrieves all ad accounts for the specified Organization.

advertiser
STRING

Name of the Advertiser

advertiser_organization_id
STRING

Organization ID of the Advertiser selected

agency_client_metadata
OBJECT

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

name
STRING

email
STRING

address_line_1
STRING

city
STRING

administrative_district_level_1
STRING

country
STRING

zipcode
STRING

tax_id
STRING

ad_accounts (table), agency_client_metadata (attribute)

agency_representing_client
STRING

Account name

billing_type
STRING

Type of billing

client_based_in_country
STRING

Required if agency_representing_client is true and if Advertiser is based in France or targeting Ads to audiences in France

client_paying_invoices
BOOLEAN

Required if agency_representing_client is true and if Advertiser is based in France or targeting Ads to audiences in France

created_at
DATE-TIME

Date and Time at which Ad Account was created

currency
STRING

Account currency

funding_source_ids
ARRAY

Array of Funding Source IDs

items
STRING

Funding Source ID

ad_accounts (table), funding_source_ids (attribute)

id
STRING

AD Account ID

lifetime_spend_cap_micro
INTEGER

Required if billing_type is set to IO, the lifetime spend cap of the account in micro currency

name
STRING

Name of the AD Account

organization_id
STRING

Oragnization ID

paying_advertiser_name
STRING

Name of the paying advertiser/political entity

regulations
OBJECT

Required if the Ad Account will contain ads for Credit, Housing or Employment, this attribute is immutable once set to true

restricted_delivery_signals
BOOLEAN

ad_accounts (table), regulations (attribute)

status
STRING

Delivery status

timezone
STRING

AD Account timezone

type
STRING

Account type. Example: DIRECT, PARTNER

updated_at
DATE-TIME

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 :

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
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
STRING

Metrics granularity. Example: DAY

id
STRING

Ad Account ID

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

Start Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups. Example: 1_DAY, 7_DAY, 28_DAY (default)

type
STRING

AD Type

view_attribution_window
STRING

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 :

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
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
STRING

Metrics granularity. Example: HOUR

id
STRING

Ad Account ID

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

Start Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups. Example: 1_DAY, 7_DAY, 28_DAY (default)

type
STRING

view_attribution_window
STRING

Attribution window for views. Example: 1_HOUR, 3_HOUR, 6_HOUR, 1_DAY (default), 7_DAY, 28_DAY


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

Official docs :

Official Docs

This stream retrieves all ad squads within a specified ad account.

ad_account_id
STRING

AD Account ID

auto_bid
BOOLEAN

Allow Snapchat to automatically set the bid to recommended amount

bid_micro
INTEGER

Max Bid (micro-currency)

bid_strategy
STRING

Bidding strategy for this Ad Squad. Example: AUTO_BID, LOWEST_COST_WITH_MAX_BID, MIN_ROAS, TARGET_COST

billing_event
STRING

Billing Event. Example: IMPRESSION

campaign_id
STRING

Campaign ID

cap_and_exclusion_config
OBJECT

The frequency cap and exclusion spec

created_at
DATE-TIME

Date and Time at which AD Squad was created

daily_budget_micro
INTEGER

Daily Budget (micro-currency)

delivery_constraint
STRING

Type of delivery

end_time
DATE-TIME

End time

id
STRING

AD Squad ID

impression_goal
STRING

Reach goal as specified in the Forecasting request

lifetime_budget_micro
INTEGER

Lifetime budget (micro-currency)

name
STRING

AD Squad name

optimization_goal
STRING

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
STRING

Type of pacing. Example: STANDARD (default), ACCELERATED

pixel_id
STRING

Pixel to be associated with the Ad Squad

placement
STRING

placement_v2
OBJECT

Placement, Json object containing advanced placement

config
STRING

Configuration for placement

platforms
STRING

The platform to place the ads

inclusion
OBJECT

Details about the content types to be included

content_types
ARRAY

List of possible content types

items
STRING

Content Type

ad_squads (table), content_types (attribute)
ad_squads (table), inclusion (attribute)

exclusion
OBJECT

Details about the content types to be excluded

content_types
ARRAY

List of possible content types

items
STRING

Content Type

ad_squads (table), content_types (attribute)
ad_squads (table), exclusion (attribute)
ad_squads (table), placement_v2 (attribute)

product_properties
OBJECT

Product Properties to be associated with the Ad Squad

product_set_id
OBJECT

The Product Set ID to be associated with the Ad Squad

catalog_id
STRING

Catalog ID

catalog_vertical
STRING

Catalog vertical, automatically set by the Catalog

ad_squads (table), product_set_id (attribute)
ad_squads (table), product_properties (attribute)

reach_and_frequency_micro
INTEGER

reach and frequency budget (micro-currency)

reach_and_frequency_status
STRING

Status of the reach and frequency booking

reach_goal
STRING

Reach goal as specified in the Forecasting request

start_time
DATE-TIME

Start Time

status
STRING

Ad Squad status. Example: ACTIVE, PAUSED

target_bid
BOOLEAN

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
OBJECT

Targeting spec

regulated_content
BOOLEAN

enable_targeting_expansion
BOOLEAN

demographics
ARRAY

items
OBJECT

ad_squads (table), demographics (attribute)

devices
ARRAY

items
OBJECT

ad_squads (table), devices (attribute)

geos
ARRAY

items
OBJECT

ad_squads (table), geos (attribute)

interests
ARRAY

items
OBJECT

ad_squads (table), interests (attribute)

segments
ARRAY

items

ad_squads (table), segments (attribute)
ad_squads (table), targeting (attribute)

targeting_reach_status
STRING

Status of target reach. Example: VALID, INVALID

type
STRING

AD Squad type

updated_at
DATE-TIME

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 :

Official Docs

This stream retrieves stats for the specified Ad Squad at DAY granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**

conversion_level_completes_app
INTEGER

conversion_level_completes_web
INTEGER

conversion_list_view
INTEGER

Number of attributed LIST_VIEW conversion events++

conversion_list_view_app
INTEGER

conversion_list_view_web
INTEGER

conversion_login
INTEGER

Number of attributed LOGIN conversion events

conversion_login_app
INTEGER

conversion_login_web
INTEGER

conversion_page_views
INTEGER

Number of attributed PAGE_VIEW conversion events**

conversion_page_views_app
INTEGER

conversion_page_views_web
INTEGER

conversion_purchases
INTEGER

Number of attributed PURCHASE conversion events

conversion_purchases_app
INTEGER

conversion_purchases_value
INTEGER

Value of attributed PURCHASE conversion events (microcurrency in Ad Account’s currency)

conversion_purchases_value_app
INTEGER

conversion_purchases_value_web
INTEGER

conversion_purchases_web
INTEGER

conversion_rate
INTEGER

Number of attributed RATE conversion events

conversion_rate_app
INTEGER

conversion_rate_web
INTEGER

conversion_reserve
INTEGER

Number of attributed CONVERSION_RESERVE conversion events++

conversion_reserve_app
INTEGER

conversion_reserve_web
INTEGER

conversion_save
INTEGER

Number of attributed SAVE conversion events

conversion_save_app
INTEGER

conversion_save_web
INTEGER

conversion_searches
INTEGER

Number of attributed SEARCH conversion events

conversion_searches_app
INTEGER

conversion_searches_web
INTEGER

conversion_share
INTEGER

Number of attributed CONVERSION_SHARE conversion events

conversion_share_app
INTEGER

conversion_share_web
INTEGER

conversion_sign_ups
INTEGER

Number of attributed SIGN_UP conversion events

conversion_sign_ups_app
INTEGER

conversion_sign_ups_web
INTEGER

conversion_spend_credits
INTEGER

Number of attributed CONVERSION_SPEND_CREDITS conversion events

conversion_spend_credits_app
INTEGER

conversion_spend_credits_web
INTEGER

conversion_start_checkout
INTEGER

Number of attributed START_CHECKOUT conversion events

conversion_start_checkout_app
INTEGER

conversion_start_checkout_web
INTEGER

conversion_start_trial
INTEGER

Number of attributed CONVERSION_START_TRIAL conversion events

conversion_start_trial_app
INTEGER

conversion_start_trial_web
INTEGER

conversion_subscribe
INTEGER

Number of attributed SUBSCRIBE conversion events

conversion_subscribe_app
INTEGER

conversion_subscribe_web
INTEGER

conversion_view_content
INTEGER

Number of attributed VIEW_CONTENT conversion events

conversion_view_content_app
INTEGER

conversion_view_content_web
INTEGER

custom_event_1
INTEGER

Number of attributed CUSTOM_EVENT_1 conversion events

custom_event_1_app
INTEGER

custom_event_1_web
INTEGER

custom_event_2
INTEGER

Number of attributed CUSTOM_EVENT_2 conversion events++

custom_event_2_app
INTEGER

custom_event_2_web
INTEGER

custom_event_3
INTEGER

Number of attributed CUSTOM_EVENT_3 conversion events++

custom_event_3_app
INTEGER

custom_event_3_web
INTEGER

custom_event_4
INTEGER

Number of attributed CUSTOM_EVENT_4 conversion events++

custom_event_4_app
INTEGER

custom_event_4_web
INTEGER

custom_event_5
INTEGER

Number of attributed CUSTOM_EVENT_5 conversion events++

custom_event_5_app
INTEGER

custom_event_5_web
INTEGER

end_time
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
NUMBER

Average number of Impressions per User Reached

granularity
STRING

Metrics granularity. Example: DAY

id
STRING

AD Squad ID

impressions
INTEGER

Impression Count

ios_installs
INTEGER

Number of iOS App Installs

ios_installs_app
INTEGER

ios_installs_web
INTEGER

quartile_1
INTEGER

Video Views to 25%

quartile_2
INTEGER

Video Views to 50%

quartile_3
INTEGER

Video Views to 75%

screen_time_millis
INTEGER

Total Time Spent on top Snap Ad (milliseconds)

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

End Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups

swipe_up_percent
INTEGER

swipes
INTEGER

% of Impressions that Swiped-Up

total_installs
INTEGER

Total number of App Installs

total_installs_app
INTEGER

total_installs_web
INTEGER

type
STRING

uniques
INTEGER

Number of unique impressions

video_views
INTEGER

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
INTEGER

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
INTEGER

The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups

view_attribution_window
STRING

Attribution window for views

view_completion
INTEGER

Video Views to completion

view_time_millis
INTEGER

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 :

Official Docs

This stream retrieves stats for the specified Ad Squad at HOUR granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**

conversion_level_completes_app
INTEGER

conversion_level_completes_web
INTEGER

conversion_list_view
INTEGER

Number of attributed LIST_VIEW conversion events++

conversion_list_view_app
INTEGER

conversion_list_view_web
INTEGER

conversion_login
INTEGER

Number of attributed LOGIN conversion events

conversion_login_app
INTEGER

conversion_login_web
INTEGER

conversion_page_views
INTEGER

Number of attributed PAGE_VIEW conversion events**

conversion_page_views_app
INTEGER

conversion_page_views_web
INTEGER

conversion_purchases
INTEGER

Number of attributed PURCHASE conversion events

conversion_purchases_app
INTEGER

conversion_purchases_value
INTEGER

Value of attributed PURCHASE conversion events (microcurrency in Ad Account’s currency)

conversion_purchases_value_app
INTEGER

conversion_purchases_value_web
INTEGER

conversion_purchases_web
INTEGER

conversion_rate
INTEGER

Number of attributed RATE conversion events

conversion_rate_app
INTEGER

conversion_rate_web
INTEGER

conversion_reserve
INTEGER

Number of attributed CONVERSION_RESERVE conversion events++

conversion_reserve_app
INTEGER

conversion_reserve_web
INTEGER

conversion_save
INTEGER

Number of attributed SAVE conversion events

conversion_save_app
INTEGER

conversion_save_web
INTEGER

conversion_searches
INTEGER

Number of attributed SEARCH conversion events

conversion_searches_app
INTEGER

conversion_searches_web
INTEGER

conversion_share
INTEGER

Number of attributed CONVERSION_SHARE conversion events

conversion_share_app
INTEGER

conversion_share_web
INTEGER

conversion_sign_ups
INTEGER

Number of attributed SIGN_UP conversion events

conversion_sign_ups_app
INTEGER

conversion_sign_ups_web
INTEGER

conversion_spend_credits
INTEGER

Number of attributed CONVERSION_SPEND_CREDITS conversion events

conversion_spend_credits_app
INTEGER

conversion_spend_credits_web
INTEGER

conversion_start_checkout
INTEGER

Number of attributed START_CHECKOUT conversion events

conversion_start_checkout_app
INTEGER

conversion_start_checkout_web
INTEGER

conversion_start_trial
INTEGER

Number of attributed CONVERSION_START_TRIAL conversion events

conversion_start_trial_app
INTEGER

conversion_start_trial_web
INTEGER

conversion_subscribe
INTEGER

Number of attributed SUBSCRIBE conversion events

conversion_subscribe_app
INTEGER

conversion_subscribe_web
INTEGER

conversion_view_content
INTEGER

Number of attributed VIEW_CONTENT conversion events

conversion_view_content_app
INTEGER

conversion_view_content_web
INTEGER

custom_event_1
INTEGER

Number of attributed CUSTOM_EVENT_1 conversion events

custom_event_1_app
INTEGER

custom_event_1_web
INTEGER

custom_event_2
INTEGER

Number of attributed CUSTOM_EVENT_2 conversion events++

custom_event_2_app
INTEGER

custom_event_2_web
INTEGER

custom_event_3
INTEGER

Number of attributed CUSTOM_EVENT_3 conversion events++

custom_event_3_app
INTEGER

custom_event_3_web
INTEGER

custom_event_4
INTEGER

Number of attributed CUSTOM_EVENT_4 conversion events++

custom_event_4_app
INTEGER

custom_event_4_web
INTEGER

custom_event_5
INTEGER

Number of attributed CUSTOM_EVENT_5 conversion events++

custom_event_5_app
INTEGER

custom_event_5_web
INTEGER

end_time
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
NUMBER

Average number of Impressions per User Reached

granularity
STRING

Metrics granularity. Example: HOUR

id
STRING

AD Squad ID

impressions
INTEGER

Impression Count

ios_installs
INTEGER

Number of iOS App Installs

ios_installs_app
INTEGER

ios_installs_web
INTEGER

quartile_1
INTEGER

Video Views to 25%

quartile_2
INTEGER

Video Views to 50%

quartile_3
INTEGER

Video Views to 75%

screen_time_millis
INTEGER

Total Time Spent on top Snap Ad (milliseconds)

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

End Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups

swipe_up_percent
INTEGER

swipes
INTEGER

% of Impressions that Swiped-Up

total_installs
INTEGER

Total number of App Installs

total_installs_app
INTEGER

total_installs_web
INTEGER

type
STRING

uniques
INTEGER

Number of unique impressions

video_views
INTEGER

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
INTEGER

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
INTEGER

The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups

view_attribution_window
STRING

Attribution window for views

view_completion
INTEGER

Video Views to completion

view_time_millis
INTEGER

Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds)


Replication Method :

Key-based Incremental

Replication Key :

end_time

Primary Key :

id : start_time

Official docs :

Official Docs

This stream retrieves stats for the specified Ad at DAY granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**

conversion_level_completes_app
INTEGER

conversion_level_completes_web
INTEGER

conversion_list_view
INTEGER

Number of attributed LIST_VIEW conversion events++

conversion_list_view_app
INTEGER

conversion_list_view_web
INTEGER

conversion_login
INTEGER

Number of attributed LOGIN conversion events

conversion_login_app
INTEGER

conversion_login_web
INTEGER

conversion_page_views
INTEGER

Number of attributed PAGE_VIEW conversion events**

conversion_page_views_app
INTEGER

conversion_page_views_web
INTEGER

conversion_purchases
INTEGER

Number of attributed PURCHASE conversion events

conversion_purchases_app
INTEGER

conversion_purchases_value
INTEGER

Value of attributed PURCHASE conversion events (microcurrency in Ad Account’s currency)

conversion_purchases_value_app
INTEGER

conversion_purchases_value_web
INTEGER

conversion_purchases_web
INTEGER

conversion_rate
INTEGER

Number of attributed RATE conversion events

conversion_rate_app
INTEGER

conversion_rate_web
INTEGER

conversion_reserve
INTEGER

Number of attributed CONVERSION_RESERVE conversion events++

conversion_reserve_app
INTEGER

conversion_reserve_web
INTEGER

conversion_save
INTEGER

Number of attributed SAVE conversion events

conversion_save_app
INTEGER

conversion_save_web
INTEGER

conversion_searches
INTEGER

Number of attributed SEARCH conversion events

conversion_searches_app
INTEGER

conversion_searches_web
INTEGER

conversion_share
INTEGER

Number of attributed CONVERSION_SHARE conversion events

conversion_share_app
INTEGER

conversion_share_web
INTEGER

conversion_sign_ups
INTEGER

Number of attributed SIGN_UP conversion events

conversion_sign_ups_app
INTEGER

conversion_sign_ups_web
INTEGER

conversion_spend_credits
INTEGER

Number of attributed CONVERSION_SPEND_CREDITS conversion events

conversion_spend_credits_app
INTEGER

conversion_spend_credits_web
INTEGER

conversion_start_checkout
INTEGER

Number of attributed START_CHECKOUT conversion events

conversion_start_checkout_app
INTEGER

conversion_start_checkout_web
INTEGER

conversion_start_trial
INTEGER

Number of attributed CONVERSION_START_TRIAL conversion events

conversion_start_trial_app
INTEGER

conversion_start_trial_web
INTEGER

conversion_subscribe
INTEGER

Number of attributed SUBSCRIBE conversion events

conversion_subscribe_app
INTEGER

conversion_subscribe_web
INTEGER

conversion_view_content
INTEGER

Number of attributed VIEW_CONTENT conversion events

conversion_view_content_app
INTEGER

conversion_view_content_web
INTEGER

custom_event_1
INTEGER

Number of attributed CUSTOM_EVENT_1 conversion events

custom_event_1_app
INTEGER

custom_event_1_web
INTEGER

custom_event_2
INTEGER

Number of attributed CUSTOM_EVENT_2 conversion events++

custom_event_2_app
INTEGER

custom_event_2_web
INTEGER

custom_event_3
INTEGER

Number of attributed CUSTOM_EVENT_3 conversion events++

custom_event_3_app
INTEGER

custom_event_3_web
INTEGER

custom_event_4
INTEGER

Number of attributed CUSTOM_EVENT_4 conversion events++

custom_event_4_app
INTEGER

custom_event_4_web
INTEGER

custom_event_5
INTEGER

Number of attributed CUSTOM_EVENT_5 conversion events++

custom_event_5_app
INTEGER

custom_event_5_web
INTEGER

end_time
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
NUMBER

Average number of Impressions per User Reached

granularity
STRING

Metrics granularity. Example: DAY

id
STRING

AD Stat ID

impressions
INTEGER

Impression Count

ios_installs
INTEGER

Number of iOS App Installs

ios_installs_app
INTEGER

ios_installs_web
INTEGER

quartile_1
INTEGER

Video Views to 25%

quartile_2
INTEGER

Video Views to 50%

quartile_3
INTEGER

Video Views to 75%

screen_time_millis
INTEGER

Total Time Spent on top Snap Ad (milliseconds)

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

End Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups

swipe_up_percent
INTEGER

swipes
INTEGER

% of Impressions that Swiped-Up

total_installs
INTEGER

Total number of App Installs

total_installs_app
INTEGER

total_installs_web
INTEGER

type
STRING

uniques
INTEGER

Number of unique impressions

video_views
INTEGER

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
INTEGER

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
INTEGER

The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups

view_attribution_window
STRING

Attribution window for views

view_completion
INTEGER

Video Views to completion

view_time_millis
INTEGER

Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds)


Replication Method :

Key-based Incremental

Replication Key :

end_time

Primary Key :

id : start_time

Official docs :

Official Docs

This stream retrieves stats for the specified Ad at HOUR granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**

conversion_level_completes_app
INTEGER

conversion_level_completes_web
INTEGER

conversion_list_view
INTEGER

Number of attributed LIST_VIEW conversion events++

conversion_list_view_app
INTEGER

conversion_list_view_web
INTEGER

conversion_login
INTEGER

Number of attributed LOGIN conversion events

conversion_login_app
INTEGER

conversion_login_web
INTEGER

conversion_page_views
INTEGER

Number of attributed PAGE_VIEW conversion events**

conversion_page_views_app
INTEGER

conversion_page_views_web
INTEGER

conversion_purchases
INTEGER

Number of attributed PURCHASE conversion events

conversion_purchases_app
INTEGER

conversion_purchases_value
INTEGER

Value of attributed PURCHASE conversion events (microcurrency in Ad Account’s currency)

conversion_purchases_value_app
INTEGER

conversion_purchases_value_web
INTEGER

conversion_purchases_web
INTEGER

conversion_rate
INTEGER

Number of attributed RATE conversion events

conversion_rate_app
INTEGER

conversion_rate_web
INTEGER

conversion_reserve
INTEGER

Number of attributed CONVERSION_RESERVE conversion events++

conversion_reserve_app
INTEGER

conversion_reserve_web
INTEGER

conversion_save
INTEGER

Number of attributed SAVE conversion events

conversion_save_app
INTEGER

conversion_save_web
INTEGER

conversion_searches
INTEGER

Number of attributed SEARCH conversion events

conversion_searches_app
INTEGER

conversion_searches_web
INTEGER

conversion_share
INTEGER

Number of attributed CONVERSION_SHARE conversion events

conversion_share_app
INTEGER

conversion_share_web
INTEGER

conversion_sign_ups
INTEGER

Number of attributed SIGN_UP conversion events

conversion_sign_ups_app
INTEGER

conversion_sign_ups_web
INTEGER

conversion_spend_credits
INTEGER

Number of attributed CONVERSION_SPEND_CREDITS conversion events

conversion_spend_credits_app
INTEGER

conversion_spend_credits_web
INTEGER

conversion_start_checkout
INTEGER

Number of attributed START_CHECKOUT conversion events

conversion_start_checkout_app
INTEGER

conversion_start_checkout_web
INTEGER

conversion_start_trial
INTEGER

Number of attributed CONVERSION_START_TRIAL conversion events

conversion_start_trial_app
INTEGER

conversion_start_trial_web
INTEGER

conversion_subscribe
INTEGER

Number of attributed SUBSCRIBE conversion events

conversion_subscribe_app
INTEGER

conversion_subscribe_web
INTEGER

conversion_view_content
INTEGER

Number of attributed VIEW_CONTENT conversion events

conversion_view_content_app
INTEGER

conversion_view_content_web
INTEGER

custom_event_1
INTEGER

Number of attributed CUSTOM_EVENT_1 conversion events

custom_event_1_app
INTEGER

custom_event_1_web
INTEGER

custom_event_2
INTEGER

Number of attributed CUSTOM_EVENT_2 conversion events++

custom_event_2_app
INTEGER

custom_event_2_web
INTEGER

custom_event_3
INTEGER

Number of attributed CUSTOM_EVENT_3 conversion events++

custom_event_3_app
INTEGER

custom_event_3_web
INTEGER

custom_event_4
INTEGER

Number of attributed CUSTOM_EVENT_4 conversion events++

custom_event_4_app
INTEGER

custom_event_4_web
INTEGER

custom_event_5
INTEGER

Number of attributed CUSTOM_EVENT_5 conversion events++

custom_event_5_app
INTEGER

custom_event_5_web
INTEGER

end_time
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
NUMBER

Average number of Impressions per User Reached

granularity
STRING

Metrics granularity. Example: HOUR

id
STRING

AD Stat ID

impressions
INTEGER

Impression Count

ios_installs
INTEGER

Number of iOS App Installs

ios_installs_app
INTEGER

ios_installs_web
INTEGER

quartile_1
INTEGER

Video Views to 25%

quartile_2
INTEGER

Video Views to 50%

quartile_3
INTEGER

Video Views to 75%

screen_time_millis
INTEGER

Total Time Spent on top Snap Ad (milliseconds)

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

End Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups

swipe_up_percent
INTEGER

swipes
INTEGER

% of Impressions that Swiped-Up

total_installs
INTEGER

Total number of App Installs

total_installs_app
INTEGER

total_installs_web
INTEGER

type
STRING

uniques
INTEGER

Number of unique impressions

video_views
INTEGER

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
INTEGER

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
INTEGER

The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups

view_attribution_window
STRING

Attribution window for views

view_completion
INTEGER

Video Views to completion

view_time_millis
INTEGER

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 :

Official Docs

This stream retrieves all Customer List segments within a specified ad account.

ad_account_id
STRING

Ad Account ID

approximate_number_users
INTEGER

Approximate number of users in the segment

created_at
DATE-TIME

Date of creation

description
STRING

Audience Segment Description

id
STRING

Segment ID

name
STRING

Segment Name

organization_id
STRING

Organization ID

retention_in_days
INTEGER

Number of days to retain audience members

source_type
STRING

Data source type

status
STRING

Status of the segment

targetable_status
STRING

Status of whether this segment can be targeted

updated_at
DATE-TIME

Date of last update

upload_status
STRING

Upload status of the segment

visible_to
ARRAY

items
STRING

audience_segments (table), visible_to (attribute)

Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

Official docs :

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
STRING

Address line 1

administrative_district_level_1
STRING

District

alternative_email_addresses
STRING

Array of email addresses

country
STRING

Country

created_at
DATE-TIME

Date of creation

email_address
STRING

Email address

id
STRING

Billing Center ID

locality
STRING

Locality name

name
STRING

Billing center name

organization_id
STRING

Organization ID

postal_code
STRING

Post code

updated_at
DATE-TIME

Date and Time at which the billing center was last updated


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

Official docs :

Official Docs

This stream retrieves all campaigns within a specified ad account

ad_account_id
STRING

Ad Account ID

buy_model
STRING

Buy Model. Example: AUCTION(default), RESERVED

created_at
DATE-TIME

Date of creation

daily_budget_micro
INTEGER

Daily Spend Cap (micro-currency)

end_time
DATE-TIME

End time of the Campaign

id
STRING

Campaign ID

lifetime_spend_cap_micro
INTEGER

Lifetime spend cap for the campaign (microcurrency)

measurement_spec
OBJECT

The apps to be tracked for this campaign

name
STRING

Campaign name

objective
STRING

Objective of the Campaign. Default: BRAND_AWARENESS

regulations
OBJECT

Required for Campaigns that run Ads for Credit, Housing, Employment (CHE)

start_time
DATE-TIME

Start Time of Campaign

status
STRING

Campaign status

updated_at
DATE-TIME

Date of last updated


campaign_stats_daily

Replication Method :

Key-based Incremental

Replication Key :

end_time

Primary Key :

id : start_time

Official docs :

Official Docs

This stream retrieves stats for the specified Campaign at DAY granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**

conversion_level_completes_app
INTEGER

conversion_level_completes_web
INTEGER

conversion_list_view
INTEGER

Number of attributed LIST_VIEW conversion events++

conversion_list_view_app
INTEGER

conversion_list_view_web
INTEGER

conversion_login
INTEGER

Number of attributed LOGIN conversion events

conversion_login_app
INTEGER

conversion_login_web
INTEGER

conversion_page_views
INTEGER

Number of attributed PAGE_VIEW conversion events**

conversion_page_views_app
INTEGER

conversion_page_views_web
INTEGER

conversion_purchases
INTEGER

Number of attributed PURCHASE conversion events

conversion_purchases_app
INTEGER

conversion_purchases_value
INTEGER

Value of attributed PURCHASE conversion events (microcurrency in Ad Account’s currency)

conversion_purchases_value_app
INTEGER

conversion_purchases_value_web
INTEGER

conversion_purchases_web
INTEGER

conversion_rate
INTEGER

Number of attributed RATE conversion events

conversion_rate_app
INTEGER

conversion_rate_web
INTEGER

conversion_reserve
INTEGER

Number of attributed CONVERSION_RESERVE conversion events++

conversion_reserve_app
INTEGER

conversion_reserve_web
INTEGER

conversion_save
INTEGER

Number of attributed SAVE conversion events

conversion_save_app
INTEGER

conversion_save_web
INTEGER

conversion_searches
INTEGER

Number of attributed SEARCH conversion events

conversion_searches_app
INTEGER

conversion_searches_web
INTEGER

conversion_share
INTEGER

Number of attributed CONVERSION_SHARE conversion events

conversion_share_app
INTEGER

conversion_share_web
INTEGER

conversion_sign_ups
INTEGER

Number of attributed SIGN_UP conversion events

conversion_sign_ups_app
INTEGER

conversion_sign_ups_web
INTEGER

conversion_spend_credits
INTEGER

Number of attributed CONVERSION_SPEND_CREDITS conversion events

conversion_spend_credits_app
INTEGER

conversion_spend_credits_web
INTEGER

conversion_start_checkout
INTEGER

Number of attributed START_CHECKOUT conversion events

conversion_start_checkout_app
INTEGER

conversion_start_checkout_web
INTEGER

conversion_start_trial
INTEGER

Number of attributed CONVERSION_START_TRIAL conversion events

conversion_start_trial_app
INTEGER

conversion_start_trial_web
INTEGER

conversion_subscribe
INTEGER

Number of attributed SUBSCRIBE conversion events

conversion_subscribe_app
INTEGER

conversion_subscribe_web
INTEGER

conversion_view_content
INTEGER

Number of attributed VIEW_CONTENT conversion events

conversion_view_content_app
INTEGER

conversion_view_content_web
INTEGER

custom_event_1
INTEGER

Number of attributed CUSTOM_EVENT_1 conversion events

custom_event_1_app
INTEGER

custom_event_1_web
INTEGER

custom_event_2
INTEGER

Number of attributed CUSTOM_EVENT_2 conversion events++

custom_event_2_app
INTEGER

custom_event_2_web
INTEGER

custom_event_3
INTEGER

Number of attributed CUSTOM_EVENT_3 conversion events++

custom_event_3_app
INTEGER

custom_event_3_web
INTEGER

custom_event_4
INTEGER

Number of attributed CUSTOM_EVENT_4 conversion events++

custom_event_4_app
INTEGER

custom_event_4_web
INTEGER

custom_event_5
INTEGER

Number of attributed CUSTOM_EVENT_5 conversion events++

custom_event_5_app
INTEGER

custom_event_5_web
INTEGER

end_time
DATE-TIME

End Time (ISO 8601)

finalized_data_end_time
DATE-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
NUMBER

Average number of Impressions per User Reached

granularity
STRING

Metrics granularity. Example: DAY

id
STRING

Campaign ID

impressions
INTEGER

Impression Count

ios_installs
INTEGER

Number of iOS App Installs

ios_installs_app
INTEGER

ios_installs_web
INTEGER

quartile_1
INTEGER

Video Views to 25%

quartile_2
INTEGER

Video Views to 50%

quartile_3
INTEGER

Video Views to 75%

screen_time_millis
INTEGER

Total Time Spent on top Snap Ad (milliseconds)

spend
INTEGER

Amount Spent (micro-currency)

start_time
DATE-TIME

End Time (ISO 8601)

swipe_up_attribution_window
STRING

Attribution window for swipe ups

swipe_up_percent
INTEGER

swipes
INTEGER

% of Impressions that Swiped-Up

total_installs
INTEGER

Total number of App Installs

total_installs_app
INTEGER

total_installs_web
INTEGER

type
STRING

uniques
INTEGER

Number of unique impressions

video_views
INTEGER

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
INTEGER

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
INTEGER

The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups

view_attribution_window
STRING

Attribution window for views

view_completion
INTEGER

Video Views to completion

view_time_millis
INTEGER

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 :

Official Docs

This stream retrieves stats for the specified Campaign at HOUR granularity

android_installs
INTEGER

Number of Android App Installs

android_installs_app
INTEGER

android_installs_web
INTEGER

attachment_avg_view_time_millis
INTEGER

Average Attachment View Time (milli-seconds)

attachment_frequency
NUMBER

Average number of Attachment Views per User Reached

attachment_impressions
INTEGER

attachment_quartile_1
INTEGER

Long Form Video Views to 25%

attachment_quartile_2
INTEGER

Long Form Video Views to 50%

attachment_quartile_3
INTEGER

Long Form Video Views to 75%

attachment_total_view_time_millis
INTEGER

Total Attachment View Time (milli-seconds)

attachment_uniques
INTEGER

Number of unique attachment impressions

attachment_view_completion
INTEGER

Long Form Video Views to completion

avg_screen_time_millis
INTEGER

Average Top Snap view time across all impressions

avg_view_time_millis
INTEGER

Use avg_screen_time_millis instead. Average Top Snap view time per User Reached

conversion_achievement_unlocked
INTEGER

Number of attributed ACHIEVEMENT_UNLOCKED conversion events

conversion_achievement_unlocked_app
INTEGER

conversion_achievement_unlocked_web
INTEGER

conversion_ad_click
INTEGER

Number of attributed AD_CLICK conversion events

conversion_ad_click_app
INTEGER

conversion_ad_click_web
INTEGER

conversion_ad_view
INTEGER

Number of attributed AD_VIEW conversion events

conversion_ad_view_app
INTEGER

conversion_ad_view_web
INTEGER

conversion_add_billing
INTEGER

Number of attributed ADD_BILLING conversion events

conversion_add_billing_app
INTEGER

conversion_add_billing_web
INTEGER

conversion_add_cart
INTEGER

Number of attributed ADD_CART conversion events

conversion_add_cart_app
INTEGER

conversion_add_cart_web
INTEGER

conversion_add_to_wishlist
INTEGER

Number of attributed ADD_TO_WISHLIST conversion events

conversion_add_to_wishlist_app
INTEGER

conversion_add_to_wishlist_web
INTEGER

conversion_app_opens
INTEGER

Number of attributed APP_OPEN conversion events

conversion_app_opens_app
INTEGER

conversion_app_opens_web
INTEGER

conversion_complete_tutorial
INTEGER

Number of attributed COMPLETE_TUTORIAL conversion events

conversion_complete_tutorial_app
INTEGER

conversion_complete_tutorial_web
INTEGER

conversion_invite
INTEGER

Number of attributed INVITE conversion events

conversion_invite_app
INTEGER

conversion_invite_web
INTEGER

conversion_level_completes
INTEGER

Number of attributed LEVEL_COMPLETE conversion events**