Cloud

Build 25.0.9434
  • Snapchat Ads
    • Getting Started
      • Establishing a Connection
      • OAuth Scopes and Endpoints
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Accounts
        • AudienceSegments
        • BillingCenters
        • Campaigns
        • Members
      • Views
        • AccountStats
        • Ads
        • AdSquads
        • AdSquadStats
        • AdStats
        • AdvancedDemographics
        • AudienceInsights
        • CampaignStats
        • Creatives
        • DemographicsAgeGroups
        • DemographicsGender
        • DemographicsLanguages
        • DeviceCarriers
        • DeviceConnectionTypes
        • DeviceMakes
        • DeviceOSTypes
        • DeviceOSVersions
        • FundingSources
        • GeolocationCountries
        • GeolocationMetros
        • GeolocationRegions
        • GeolocationZipCodes
        • Invoices
        • LocationCategories
        • NielsenInterests
        • Organizations
        • PlacedVisitationSegmentsInterests
        • SnapLifeStyleCategoriesInterests
      • Stored Procedures
        • AddAudienceSegmentUsers
        • CreateLookalikeSegment
        • RemoveAudienceSegmentUsers
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AccountId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • MaxThreads
        • Pagesize
        • PseudoColumns
        • RetrieveSampleStats
        • Timeout
    • Third Party Copyrights

Snapchat Ads - CData Cloud

Overview

CData Cloud offers access to Snapchat Ads across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Snapchat Ads through CData Cloud.

CData Cloud allows you to standardize and configure connections to Snapchat Ads as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Snapchat Ads appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to Snapchat Ads in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Snapchat Ads

Establishing a Connection shows how to authenticate to Snapchat Ads and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Snapchat Ads through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to Snapchat Ads by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Snapchat Ads

Snapchat Ads supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

To simplify routine queries, you can also set AccountId to provide a default AccountId. This eliminates the need to provide it manually as part of the WHERE clause. (If the AccountId is not specified and no account ID is explicitly supplied in the WHERE clause, the Cloud looks for the first account from the list returned by the Accounts view.)

The following subsections describe how to authenticate to Snapchat Ads from three common authentication flows:

  • Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
  • Web: access to data via a shared website.
  • Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Snapchat Ads, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

  1. Before connecting to data for the first time, set the following connection parameters:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id in your application settings.
    • OAuthClientSecret: The client secret in your application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set the following:
    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set the following connection properties:

    • OAuthClientId: The Client Id in your application settings.
    • OAuthClientSecret: The Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

CData Cloud

OAuth Scopes and Endpoints

Required Scopes for Snapchat Ads

When integrating with Snapchat Ads, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Snapchat Ads Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Snapchat Ads

Scope Description
System List views and columns. Required for read access.
Tenant Non-Configurable Access and execute reports as a service.
Snapchat Ads Owned Scope Include items or components owned and managed by Snapchat Ads. Required for read access.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Snapchat Ads APIs.

Key Features

  • The Cloud models Snapchat Ads entities like documents, folders, and groups as relational views, allowing you to write SQL to query Snapchat Ads data.
  • Stored procedures allow you to execute operations to Snapchat Ads.
  • Live connectivity to these objects means any changes to your Snapchat Ads account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Categories, OrderLineItems, and more.

Tables

Tables describes the available tables. Tables are statically defined to model Customers, Orders, Refunds.

Stored Procedures

Stored Procedures are function-like interfaces to Snapchat Ads. Stored procedures allow you to execute operations to Snapchat Ads, including calculating sales tax and validating addresses.

CData Cloud

Tables

The Cloud models the data in Snapchat Ads as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Snapchat Ads Tables

Name Description
Accounts Lists all the ad accounts for the specified Organization.
AudienceSegments Lists all Snap Audience Match segments within a specified ad account.
BillingCenters Lists all the billing centers for the specified Organization.
Campaigns Lists all campaigns within a specified ad account.
Members Lists all members for a specific organization.

CData Cloud

Accounts

Lists all the ad accounts for the specified Organization.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • OrganizationId supports the following operators: =,IN; If no value is specified, the Cloud will try to get the first organization from the list returned by the Organizations view.
The following queries are processed server side: 
    SELECT * FROM Accounts WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Accounts WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
    SELECT * FROM Accounts WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-28d2-40f8-982b-c353c67934cb')

Insert


INSERT INTO Accounts (Name, Type, OrganizationId, Currency, TimeZone, BillingType, BillingCenterId, RestrictedDeliverySignalsRegulation, AgencyRepresentingClient, ClientPayingInvoices, Test, FundingSourceIds, ClientBasedInCountry, AgencyClientName, AgencyClientEmail, AgencyClientAddressLine1, AgencyClientCity, AgencyClientAdministrativeDistrictLevel1, AgencyClientCountry, AgencyClientZipCode, AgencyClientTaxId) VALUES ('delicieux aliments pour chiens', 'PARTNER', 'ca67fb1a-2653-495d-9446-c9e8a30f6232', 'EUR', 'Europe/Paris', 'REVOLVING', '6e0f4532-3702-4f0b-9889-9fe5d0614afd', false, true, false, true, '["5ca1687a-f2b4-437d-8554-a85403a714c5"]', 'FR', 'Madamemoiselle Poodle', '[email protected]', '101 Boulevard la Fayette', 'Paris', 'FR-O', 'FR', '62100', 'FR12345678900')

Update


UPDATE Accounts SET Name = 'Updated name', AgencyClientName = 'Updated agency client name' WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

ID of the AD account.

OrganizationId String False

Organizations.Id

The ID of the organization.

Advertiser String False

Name of the Advertiser.

Currency String False

Account currency.

The allowed values are AUD, CAD, EUR, GBP, USD.

FundingSourceIds String False

Array of Funding Source IDs.

BillingType String False

Type of billing.

The allowed values are IO, REVOLVING.

BillingCenterId String False

BillingCenters.Id

The billing center ID.

Name String False

Account name.

Test Bool False

Indicates Ad Account is a test ad account, test ad accounts can never serve live ads.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

Timezone String False

Account timezone, remember to take the time differences into account when you set up your application.

The allowed values are Africa/Cairo, Africa/Johannesburg, America/Anchorage, America/Cancun, America/Chicago, America/Dawson, America/Dawson_Creek, America/Denver, America/Edmonton, America/Halifax, America/Hermosillo, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Montevideo, America/New_York, America/Phoenix, America/Rainy_River, America/Regina, America/Tijuana, America/Toronto, America/Vancouver, Asia/Amman, Asia/Beirut, Asia/Dubai, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jerusalem, Asia/Kamchatka, Asia/Krasnoyarsk, Asia/Magadan, Asia/Nicosia, Asia/Omsk, Asia/Qatar, Asia/Riyadh, Asia/Shanghai, Asia/Singapore, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Atlantic/Canary, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Berlin, Europe/Brussels, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Rome, Europe/Samara, Europe/Stockholm, Europe/Vienna, Europe/Vilnius, Europe/Warsaw, Europe/Zurich, Pacific/Auckland, Pacific/Honolulu, UTC.

Type String False

Account type.

The allowed values are DIRECT, PARTNER.

Status String False

Account status.

LifetimeSpendCap Decimal False

Required if BillingType is set to IO, the lifetime spend cap of the account.

AdvertiserOrganizationId String True

Organizations.Id

Organization ID of the Advertiser selected.

PayingAdvertiserName String False

Name of the paying advertiser/political entity, required if the Ad Account will contain political/advocacy ads.

RestrictedDeliverySignalsRegulation String False

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

AgencyRepresentingClient Bool False

Whether the agency is representing a client or not.

ClientBasedInCountry String False

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

The allowed values are FR.

ClientPayingInvoices Bool False

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

DeliveryStatus String True

Delivery status.

AgencyClientName String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientEmail String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientAddressLine1 String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientCity String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientAdministrativeDistrictLevel1 String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientCountry String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientZipCode String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

AgencyClientTaxId String False

Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France.

CData Cloud

AudienceSegments

Lists all Snap Audience Match segments within a specified ad account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
The following queries are processed server side: 
    SELECT * FROM AudienceSegments WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM AudienceSegments WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM AudienceSegments WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM AudienceSegments WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')

Insert


INSERT INTO AudienceSegments (Name, Description, SourceType, RetentionInDays, AccountId) VALUES ('all the sams in the world', 'all the sams in the world', 'FIRST_PARTY', 180, '422588db-75f3-47d1-be3b-92e296d33f68')

Update


UPDATE AudienceSegments SET Name = 'Updated name', Description = 'Updated description', RetentionInDays = 60 WHERE Id = '5689640350646272'

Delete


DELETE AudienceSegments WHERE Id = '4873877536079576'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

ID of the audience segment.

AccountId String False

Accounts.Id

Ad Account ID.

Description String False

Audience Segment Description.

Name String False

Audience Segment name.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

RetentionInDays Int False

Number of days to retain audience members.

The default value is 9999.

SourceType String False

Data source type.

The allowed values are FIRST_PARTY, ENGAGEMENT, PIXEL, MOBILE, FOOT_TRAFFIC_INSIGHTS.

ApproximateNumberUsers Int True

Approximate number of users in the segment.

Status String True

Status of the segment.

UploadStatus String True

Upload status of the segment.

The allowed values are NO_UPLOAD, PROCESSING, COMPLETE.

TargetableStatus String True

Status of whether this segment can be targeted.

The allowed values are NOT_READY, TOO_FEW_USERS, READY.

CData Cloud

BillingCenters

Lists all the billing centers for the specified Organization.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • OrganizationId supports the following operators: =,IN; If no value is specified, the Cloud will try to get the first organization from the list returned by the Organizations view.
The following queries are processed server side: 
    SELECT * FROM BillingCenters WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM BillingCenters WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM BillingCenters WHERE Id = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM BillingCenters WHERE Id IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '9f7c-a1d5-4579-9f7c-331deb8082b8')

Insert


INSERT INTO BillingCenters (OrganizationId, Name, EmailAddress, AddressLine1, Locality, AdministrativeDistrictLevel1, Country, PostalCode, AlternativeEmailAddresses) VALUES ('ca67fb1a-2653-495d-9446-c9e8a30f6232', 'Kianjous Billing Center', '[email protected]', '10 Honey Bear Road', 'London', 'GB-LND', 'GB', 'NW1 4RY', '["[email protected]"]')

Update


UPDATE BillingCenters SET Name = 'Updated Billing Center Name' WHERE Id = '19247038-c858-4802-b786-40c162228e18'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

ID of the billing center.

OrganizationId String False

Organizations.Id

The ID of the organization.

Name String False

Name of the Billing Center.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

EmailAddress String False

Email address.

AddressLine1 String False

Address line 1.

Locality String False

Locality.

AdministrativeDistrictLevel1 String False

District.

Country String False

Country.

PostalCode String False

Post code.

AlternativeEmailAddresses String False

Array of email addresses.

CData Cloud

Campaigns

Lists all campaigns within a specified ad account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
The following queries are processed server side: 
    SELECT * FROM Campaigns WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Campaigns WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Campaigns WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
    SELECT * FROM Campaigns WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-5f433224-28d2-40f8-982b')

Insert


INSERT INTO Campaigns (Name, AccountId, Status, StartTime, RegulationsRestrictedDeliverySignals, MeasurementSpecIOSAppId, MeasurementSpecAndroidAppURL) VALUES ('Cool Campaign', '422588db-75f3-47d1-be3b-92e296d33f68', 'PAUSED', '2016-08-11 22:03:58.869', true, '1234', 'com.snapchatads.android')

Update


UPDATE Campaigns SET Name = 'Cool Campaign (Updated)', RegulationsRestrictedDeliverySignals = false WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'

Delete


DELETE Campaigns WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Campaign ID.

AccountId String False

Accounts.Id

Ad Account ID.

DailyBudget Decimal False

Daily Spend Cap.

EndTime Datetime False

End time.

Name String False

Campaign name.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

StartTime Datetime False

Start time.

Status String False

Campaign status.

The allowed values are ACTIVE, PAUSED.

LifetimeSpendCap Decimal False

Lifetime spend cap for the campaign.

MeasurementSpecIOSAppId String False

The IOS app to be tracked for this campaign.

MeasurementSpecAndroidAppURL String False

The Android app to be tracked for this campaign.

Objective String False

[DEPRECATED] Objective of the Campaign. The field is deprecated. Use ObjectiveType and PromotionType for creating records instead.

The default value is BRAND_AWARENESS.

ObjectiveType String False

Objective type of the Campaign.

The default value is AWARENESS_AND_ENGAGEMENT.

PromotionType String False

Promotion type of the Campaign.

RegulationsRestrictedDeliverySignals Bool False

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

RegulationsCandidateBallotInformation String False

The candidate / ballot field is optional, but may be required in certain states.

DeliveryStatus String True

Delivery status.

CData Cloud

Members

Lists all members for a specific organization.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • OrganizationId supports the following operators: =,IN; If no value is specified, the Cloud will try to get the first organization from the list returned by the Organizations view.
The following queries are processed server side: 
    SELECT * FROM Members WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Members WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Members WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM Members WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')

Insert


INSERT INTO Members (OrganizationId, Email, DisplayName) VALUES ('ca67fb1a-2653-495d-9446-c9e8a30f6232', '[email protected]', 'Member 0')

Update


UPDATE Members SET DisplayName = 'Member 0 (Updated Name)' WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'

Delete


DELETE Members WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

Member Id.

OrganizationId String False

Organizations.Id

The ID of the organization.

DisplayName String False

Name of the user.

CreatedAt Datetime False

The creation date of the entity.

UpdatedAt Datetime False

The date when the entity was last updated.

MemberStatus String False

Name of the Advertiser.

The allowed values are INVITED, MEMBER.

Email String False

Email address of the user.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Snapchat Ads Views

Name Description
AccountStats Lists the spend metric for the specified Ad Account.
Ads Lists all ads within a specified ad account.
AdSquads Lists all ad squads within a specified ad account.
AdSquadStats Lists all ad squad stats.
AdStats Lists all ad stats.
AdvancedDemographics Lists all Advanced Demographics targeting options.
AudienceInsights Lists all audience insights based on the targeting options.
CampaignStats Lists all campaign stats.
Creatives Retrieves all creatives associated with an ad account
DemographicsAgeGroups Lists all age group targeting options.
DemographicsGender Lists all gender targeting options.
DemographicsLanguages Lists all language targeting options.
DeviceCarriers Lists all device carrier targeting options.
DeviceConnectionTypes Lists all device connection type targeting options.
DeviceMakes Lists all device make targeting options.
DeviceOSTypes Lists all device OS type targeting options.
DeviceOSVersions Lists all device OS version targeting options.
FundingSources Lists all funding sources for the specified Organization.
GeolocationCountries Lists all country targeting options.
GeolocationMetros Lists all metro/dma targeting options.
GeolocationRegions Lists all region/state targeting options.
GeolocationZipCodes Lists all of zipcode targeting options.
Invoices Lists all invoices for a given Ad Account.
LocationCategories Lists all location categories.
NielsenInterests Lists all Nielsen Interests targeting options.
Organizations Lists all the organizations where the authenticated user has access.
PlacedVisitationSegmentsInterests Lists all interest targeting based on Placed Visitation Segments.
SnapLifeStyleCategoriesInterests Lists all Snap Lifestyle Categories targeting options.

CData Cloud

AccountStats

Lists the spend metric for the specified Ad Account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
  • StartTime supports the following operator: =
  • EndTime supports the following operator: =
  • Granularity supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM AccountStats WHERE StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM AccountStats WHERE Granularity = 'LIFETIME' AND AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'

Note: If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.

Columns

Name Type References Description
AccountId String The Id of the entity to query.
StartTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
FinalizedDataEndTime Datetime This defines the time up until when 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 FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly.
IntervalStartTime Datetime Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime Datetime End time of the current interval. This applies only to Granularity DAY and HOUR.
Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.

The allowed values are LIFETIME, TOTAL, DAY, HOUR.

The default value is DAY.

Spend Decimal Amount Spent.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
RetrieveSampleStats Bool Whether to return sample (fake) stats or not.

CData Cloud

Ads

Lists all ads within a specified ad account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
  • AdSquadId supports the following operators: =,IN
The following queries are processed server side: 
    SELECT * FROM Ads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Ads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') 
    SELECT * FROM Ads WHERE AdSquadId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM Ads WHERE AdSquadId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM Ads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM Ads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-8f19507f6bdd-69b96ded-4871-4750')

Columns

Name Type References Description
Id [KEY] String ID of the ad.
AccountId String

Accounts.Id

Ad Account ID.
AdSquadId String

AdSquads.Id

Ad Squad ID.
CreativeId String Creative ID.
Name String Ad name.
CreatedAt Datetime The creation date of the entity.
UpdatedAt Datetime The date when the entity was last updated.
PayingAdvertiserName String Name of the paying advertiser/political entity.
ReviewStatus String Ad Review Status.

The allowed values are PENDING, APPROVED, REJECTED.

ReviewStatusReason String List of Ad Review Rejection Reasons.
Status String Ad status.

The allowed values are ACTIVE, PAUSED.

Type String Ad type.

The allowed values are SNAP_AD, LONGFORM_VIDEO, APP_INSTALL, REMOTE_WEBPAGE, DEEP_LINK, STORY, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, FILTER, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, LENS_LONGFORM_VIDEO, COLLECTION.

DeliveryStatus String Delivery status.

CData Cloud

AdSquads

Lists all ad squads within a specified ad account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
  • CampaignId supports the following operators: =,IN
The following queries are processed server side: 
    SELECT * FROM AdSquads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM AdSquads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') 
    SELECT * FROM AdSquads WHERE CampaignId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM AdSquads WHERE CampaignId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
    SELECT * FROM AdSquads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM AdSquads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')

Columns

Name Type References Description
Id [KEY] String ID of the ad squad.
AccountId String

Accounts.Id

Ad account ID.
CampaignId String

Campaigns.Id

Campaign ID.
Bid Decimal Max Bid.
BillingEvent String Billing Event.
DailyBudget Decimal Daily Budget.
LifetimeBudget Decimal Lifetime budget.
EndTime Datetime End time.
Name String Ad Squad name.
CreatedAt Datetime The creation date of the entity.
UpdatedAt Datetime The date when the entity was last updated.
OptimizationGoal String Optimization Goal.

The allowed values are IMPRESSIONS, 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.

ConversionWindow String Conversion window optimization, requires optimization_goal is one of APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_REENGAGE_OPEN.

The allowed values are SWIPE_28DAY_VIEW_1DAY, SWIPE_7D.

Placement String Placement.
StartTime Datetime Start time.
Status String Ad Squad status.

The allowed values are ACTIVE, PAUSED.

Targeting String Targeting spec.
Type String Ad Squad Type.

The allowed values are SNAP_ADS, LENS, FILTER.

CapAndExclusionConfig String The frequency cap and exclusion spec.
AdSchedulingConfig String The schedule for running ads.
BidStrategy String Bidding strategy for this Ad Squad.

The allowed values are AUTO_BID, LOWEST_COST_WITH_MAX_BID, MIN_ROAS, TARGET_COST.

RoasValue Decimal The desired ROAS used with the MIN_ROAS BidStrategy.
PixelId String Pixel to be associated with the Ad Squad.
MeasurementProviderNames String approved measurement provider.

The allowed values are MOAT_SS, DOUBLEVERIFY.

DeliveryConstraint String Type of delivery.
PacingType String Type of pacing.

The allowed values are STANDARD, ACCELERATED.

The default value is STANDARD.

DeliveryStatus String Delivery status.

CData Cloud

AdSquadStats

Lists all ad squad stats.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CampaignId supports the following operators: =,IN
  • AdSquadId supports the following operators: =,IN
  • StartTime supports the following operator: =
  • EndTime supports the following operator: =
  • Granularity supports the following operator: =
  • Dimension supports the following operator: =
  • SwipeUpAttributionWindow supports the following operator: =
  • ViewAttributionWindow supports the following operator: =
  • ConversionSourceTypes supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'

    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'

Note: You must specify either CampaignId or AdSquadId. If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.

If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.

Dimension Dimension Category
Country geos
Region geos
DMA geos
Gender demographics
Age demographics
InterestCategoryId interests
InterestCategoryName interests
OS devices
Make devices

Columns

Name Type References Description
CampaignId String

Campaigns.Id

The campaign Id.
AdSquadId String

AdSquads.Id

The ad squad id.
StartTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
FinalizedDataEndTime Datetime This defines the time up until when 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 FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly.
IntervalStartTime Datetime Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime Datetime End time of the current interval. This applies only to Granularity DAY and HOUR.
Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.
Dimension String You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined.
SwipeUpAttributionWindow String Attribution window for swipe ups.
ViewAttributionWindow String Attribution window for views.
Country String ISO country code.
Region String Region.
DMA Int DMA numeric code.
Gender String Gender.
Age String Age bucket.
InterestCategoryId String SnapchatAds User Lifestyle Interest Category Id.
InterestCategoryName String SnapchatAds User Lifestyle Interest Category Name.
OS String Device Operating System.
Make String Device Make (e.g., Apple, Samsung)
Impressions Int Impression Count.
Swipes Int Swipe-Up Count.
ViewTimeMillis Long Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds).
ScreenTimeMillis Long Total Time Spent on top Snap Ad (milliseconds).
Quartile1 Int Video Views to 25%.
Quartile2 Int Video Views to 50%.
Quartile3 Int Video Views to 75%.
ViewCompletion Int Video Views to completion.
Spend Decimal Amount Spent.
VideoViews Int 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.
AndroidInstalls Int Number of Android App Installs.
AndroidInstallsApp Int Number of Android App Installs.
AndroidInstallsWeb Int Number of Android App Installs.
AndroidInstallsSwipeUp Int Number of Android App Installs.
AndroidInstallsAppSwipeUp Int Number of Android App Installs.
AndroidInstallsWebSwipeUp Int Number of Android App Installs.
AndroidInstallsView Int Number of Android App Installs.
AndroidInstallsAppView Int Number of Android App Installs.
AndroidInstallsWebView Int Number of Android App Installs.
AttachmentAvgViewTimeMillis Long Average Attachment View Time (milli-seconds).
AttachmentFrequency Double Average number of Attachment Views per User Reached.
AttachmentQuartile1 Int Long Form Video Views to 25%.
AttachmentQuartile2 Int Long Form Video Views to 50%.
AttachmentQuartile3 Int Long Form Video Views to 75%.
AttachmentTotalViewTimeMillis Long Total Attachment View Time (milli-seconds).
AttachmentUniques Int Number of unique attachment impressions.
AttachmentViewCompletion Int Long Form Video Views to completion.
AttachmentVideoViews Int Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration.
AvgViewTimeMillis Long Use avg_screen_time_millis instead. Average Top Snap view time per User Reached.
AvgScreenTimeMillis Long Average Top Snap view time across all impressions.
Frequency Double Average number of Impressions per User Reached.
IosInstalls Int Number of iOS App Installs.
IosInstallsApp Int Number of iOS App Installs.
IosInstallsWeb Int Number of iOS App Installs.
IosInstallsSwipeUp Int Number of iOS App Installs.
IosInstallsAppSwipeUp Int Number of iOS App Installs.
IosInstallsWebSwipeUp Int Number of iOS App Installs.
IosInstallsView Int Number of iOS App Installs.
IosInstallsAppView Int Number of iOS App Installs.
IosInstallsWebView Int Number of iOS App Installs.
SwipeUpPercent Double % of Impressions that Swiped-Up.
TotalInstalls Int Total number of App Installs.
TotalInstallsApp Int Total number of App Installs.
TotalInstallsWeb Int Total number of App Installs.
TotalInstallsSwipeUp Int Total number of App Installs.
TotalInstallsAppSwipeUp Int Total number of App Installs.
TotalInstallsWebSwipeUp Int Total number of App Installs.
TotalInstallsView Int Total number of App Installs.
TotalInstallsAppView Int Total number of App Installs.
TotalInstallsWebView Int Total number of App Installs.
Uniques Int Number of unique impressions.
VideoViewsTimeBased Int The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups.
VideoViews15s Int 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.
StoryOpens Int Number of times users tapped on the ad tile in the feed to view the Story Ad.
StoryCompletes Int Number of times users viewed through to the last Snap of your Story Ad.
PositionImpressions Int The impression number for this story ad position.
PositionUniques Int The unique viewer numbers for this story ad position.
PositionFrequency Double The frequency for this story ad position.
PositionScreenTimeMillis Long The total view time in milliseconds for this story ad position.
PositionSwipeUpPercent Double The swipe up rate for this story ad position.
AvgPositionScreenTimeMillis Long The average view time for this story ad position.
Shares Int Number of times lens/filter was shared in a Chat or Story.
Saves Int Number of times lens/filter was saved to Memories.
ConversionPurchases Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValue Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSave Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckout Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCart Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContent Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBilling Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUps Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearches Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletes Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpens Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViews Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribe Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClick Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorial Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInvite Int Number of attributed 'INVITE' conversion events.
ConversionLogin Int Number of attributed 'LOGIN' conversion events.
ConversionShare Int Number of attributed 'SHARE' conversion events.
ConversionReserve Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlocked Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlist Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCredits Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRate Int Number of attributed 'RATE' conversion events.
ConversionStartTrial Int Number of attributed 'START_TRIAL' conversion events.
ConversionListView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1 Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2 Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3 Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4 Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5 Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1SwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2SwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3SwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4SwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5SwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteView Int Number of attributed 'INVITE' conversion events.
ConversionLoginView Int Number of attributed 'LOGIN' conversion events.
ConversionShareView Int Number of attributed 'SHARE' conversion events.
ConversionReserveView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1View Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2View Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3View Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4View Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5View Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesApp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueApp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveApp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutApp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartApp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentApp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingApp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsApp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesApp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesApp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensApp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsApp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeApp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickApp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewApp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialApp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteApp Int Number of attributed 'INVITE' conversion events.
ConversionLoginApp Int Number of attributed 'LOGIN' conversion events.
ConversionShareApp Int Number of attributed 'SHARE' conversion events.
ConversionReserveApp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedApp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistApp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsApp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateApp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialApp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewApp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1App Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2App Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3App Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4App Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5App Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppView Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppView Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppView Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWeb Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWeb Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWeb Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWeb Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWeb Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWeb Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWeb Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWeb Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWeb Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWeb Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWeb Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWeb Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWeb Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWeb Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWeb Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWeb Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWeb Int Number of attributed 'INVITE' conversion events.
ConversionLoginWeb Int Number of attributed 'LOGIN' conversion events.
ConversionShareWeb Int Number of attributed 'SHARE' conversion events.
ConversionReserveWeb Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWeb Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWeb Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWeb Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWeb Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWeb Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWeb Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1Web Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2Web Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3Web Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4Web Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5Web Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebView Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebView Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebView Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ConversionSourceTypes String Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total'
RetrieveSampleStats Bool Whether to return sample (fake) stats or not.

CData Cloud

AdStats

Lists all ad stats.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CampaignId supports the following operators: =,IN
  • AdId supports the following operators: =,IN
  • AccountId supports the following operators: =,IN
  • StartTime supports the following operator: =
  • EndTime supports the following operator: =
  • Granularity supports the following operator: =
  • Dimension supports the following operator: =
  • SwipeUpAttributionWindow supports the following operator: =
  • ViewAttributionWindow supports the following operator: =
  • ConversionSourceTypes supports the following operator: =
  • BreakDownMetricsByPosition supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND BreakDownMetricsByPosition = true
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'

    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND BreakDownMetricsByPosition = true
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'

SELECT * FROM AdStats WHERE AccountId IN ('68053bcd-675c-4dc7-a622-dc2ca218dcfe', '77553bcd-675c-4dc7-a622-dc2ca218dcag');

Note: You must specify either CampaignId, AdId or AccountId. When the AccountId filter is applied, the driver first retrieves the CampaignIds linked to that AccountId. It then retrieves and displays the statistics for each CampaignId. If a time window is not specified, the stats for the last seven days or the last 31 days are returned based on the specified granularity.

If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.

Dimension Dimension Category
Country geos
Region geos
DMA geos
Gender demographics
Age demographics
InterestCategoryId interests
InterestCategoryName interests
OS devices
Make devices

Columns

Name Type References Description
CampaignId String

Campaigns.Id

The campaign Id.
AdId String

Ads.Id

The ad id.
AccountId String

Accounts.Id

The account id.
PlatformPosition String The platform position.
StartTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
FinalizedDataEndTime Datetime This defines the time up until when 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 FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly.
IntervalStartTime Datetime Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime Datetime End time of the current interval. This applies only to Granularity DAY and HOUR.
Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.
Dimension String You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined.
SwipeUpAttributionWindow String Attribution window for swipe ups.
ViewAttributionWindow String Attribution window for views.
Country String ISO country code.
Region String Region.
DMA Int DMA numeric code.
Gender String Gender.
Age String Age bucket.
InterestCategoryId String SnapchatAds User Lifestyle Interest Category Id.
InterestCategoryName String SnapchatAds User Lifestyle Interest Category Name.
OS String Device Operating System.
Make String Device Make (e.g., Apple, Samsung)
Impressions Int Impression Count.
Swipes Int Swipe-Up Count.
ViewTimeMillis Long Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds).
ScreenTimeMillis Long Total Time Spent on top Snap Ad (milliseconds).
Quartile1 Int Video Views to 25%.
Quartile2 Int Video Views to 50%.
Quartile3 Int Video Views to 75%.
ViewCompletion Int Video Views to completion.
Spend Decimal Amount Spent.
VideoViews Int 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.
AndroidInstalls Int Number of Android App Installs.
AndroidInstallsApp Int Number of Android App Installs.
AndroidInstallsWeb Int Number of Android App Installs.
AndroidInstallsSwipeUp Int Number of Android App Installs.
AndroidInstallsAppSwipeUp Int Number of Android App Installs.
AndroidInstallsWebSwipeUp Int Number of Android App Installs.
AndroidInstallsView Int Number of Android App Installs.
AndroidInstallsAppView Int Number of Android App Installs.
AndroidInstallsWebView Int Number of Android App Installs.
AttachmentAvgViewTimeMillis Long Average Attachment View Time (milli-seconds).
AttachmentFrequency Double Average number of Attachment Views per User Reached.
AttachmentQuartile1 Int Long Form Video Views to 25%.
AttachmentQuartile2 Int Long Form Video Views to 50%.
AttachmentQuartile3 Int Long Form Video Views to 75%.
AttachmentTotalViewTimeMillis Long Total Attachment View Time (milli-seconds).
AttachmentUniques Int Number of unique attachment impressions.
AttachmentViewCompletion Int Long Form Video Views to completion.
AttachmentVideoViews Int Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration.
AvgViewTimeMillis Long Use avg_screen_time_millis instead. Average Top Snap view time per User Reached.
AvgScreenTimeMillis Long Average Top Snap view time across all impressions.
Frequency Double Average number of Impressions per User Reached.
IosInstalls Int Number of iOS App Installs.
IosInstallsApp Int Number of iOS App Installs.
IosInstallsWeb Int Number of iOS App Installs.
IosInstallsSwipeUp Int Number of iOS App Installs.
IosInstallsAppSwipeUp Int Number of iOS App Installs.
IosInstallsWebSwipeUp Int Number of iOS App Installs.
IosInstallsView Int Number of iOS App Installs.
IosInstallsAppView Int Number of iOS App Installs.
IosInstallsWebView Int Number of iOS App Installs.
SwipeUpPercent Double % of Impressions that Swiped-Up.
TotalInstalls Int Total number of App Installs.
TotalInstallsApp Int Total number of App Installs.
TotalInstallsWeb Int Total number of App Installs.
TotalInstallsSwipeUp Int Total number of App Installs.
TotalInstallsAppSwipeUp Int Total number of App Installs.
TotalInstallsWebSwipeUp Int Total number of App Installs.
TotalInstallsView Int Total number of App Installs.
TotalInstallsAppView Int Total number of App Installs.
TotalInstallsWebView Int Total number of App Installs.
Uniques Int Number of unique impressions.
VideoViewsTimeBased Int The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups.
VideoViews15s Int 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.
StoryOpens Int Number of times users tapped on the ad tile in the feed to view the Story Ad.
StoryCompletes Int Number of times users viewed through to the last Snap of your Story Ad.
PositionImpressions Int The impression number for this story ad position.
PositionUniques Int The unique viewer numbers for this story ad position.
PositionFrequency Double The frequency for this story ad position.
PositionScreenTimeMillis Long The total view time in milliseconds for this story ad position.
PositionSwipeUpPercent Double The swipe up rate for this story ad position.
AvgPositionScreenTimeMillis Long The average view time for this story ad position.
Shares Int Number of times lens/filter was shared in a Chat or Story.
Saves Int Number of times lens/filter was saved to Memories.
ConversionPurchases Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValue Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSave Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckout Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCart Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContent Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBilling Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUps Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearches Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletes Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpens Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViews Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribe Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClick Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorial Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInvite Int Number of attributed 'INVITE' conversion events.
ConversionLogin Int Number of attributed 'LOGIN' conversion events.
ConversionShare Int Number of attributed 'SHARE' conversion events.
ConversionReserve Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlocked Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlist Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCredits Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRate Int Number of attributed 'RATE' conversion events.
ConversionStartTrial Int Number of attributed 'START_TRIAL' conversion events.
ConversionListView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1 Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2 Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3 Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4 Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5 Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1SwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2SwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3SwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4SwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5SwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteView Int Number of attributed 'INVITE' conversion events.
ConversionLoginView Int Number of attributed 'LOGIN' conversion events.
ConversionShareView Int Number of attributed 'SHARE' conversion events.
ConversionReserveView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1View Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2View Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3View Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4View Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5View Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesApp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueApp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveApp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutApp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartApp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentApp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingApp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsApp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesApp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesApp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensApp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsApp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeApp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickApp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewApp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialApp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteApp Int Number of attributed 'INVITE' conversion events.
ConversionLoginApp Int Number of attributed 'LOGIN' conversion events.
ConversionShareApp Int Number of attributed 'SHARE' conversion events.
ConversionReserveApp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedApp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistApp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsApp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateApp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialApp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewApp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1App Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2App Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3App Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4App Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5App Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppView Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppView Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppView Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWeb Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWeb Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWeb Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWeb Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWeb Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWeb Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWeb Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWeb Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWeb Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWeb Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWeb Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWeb Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWeb Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWeb Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWeb Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWeb Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWeb Int Number of attributed 'INVITE' conversion events.
ConversionLoginWeb Int Number of attributed 'LOGIN' conversion events.
ConversionShareWeb Int Number of attributed 'SHARE' conversion events.
ConversionReserveWeb Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWeb Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWeb Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWeb Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWeb Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWeb Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWeb Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1Web Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2Web Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3Web Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4Web Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5Web Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebView Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebView Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebView Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
BreakDownMetricsByPosition String Whether to break down metrics by position or not.
ConversionSourceTypes String Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total'
RetrieveSampleStats Bool Whether to return sample (fake) stats or not.

CData Cloud

AdvancedDemographics

Lists all Advanced Demographics targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM AdvancedDemographics

Columns

Name Type References Description
Id [KEY] String The ID of the target option.
Name String The name of the target option.
Path String The path of the target option.
Source String The source of the target option.

CData Cloud

AudienceInsights

Lists all audience insights based on the targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • AccountId supports the following operator: =
  • DimensionCategory supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'
    SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND DimensionCategory = 'demo' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'

Note: AccountId, BaseSpecCountryCode and TargetingSpecCountryCode are required. OR logical operator and NOT clause are supported server side. Targeting options must be grouped based on the dimension category.

Targeting Option Dimension Category
AgeGroup demographics
MinAge demographics
MaxAge demographics
Gender demographics
Language demographics
AdvancedDemographics demographics
DeviceConnectionType devices
DeviceOSType devices
DeviceOSVersionMin devices
DeviceOSVersionMax devices
DeviceCarrierId devices
DeviceMake devices
CountryCode geos
RegionId geos
MetroId geos
ZipCode geos
LocationCategoryId locations
LocationProximity locations
LocationProximityUnit locations
Latitude locations
Longitude locations
Radius locations
Unit locations
SegmentId segments
InterestCategoryId interests

Example Targeting Specs

United States, Male+Female, All Age Ranges 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'

United States, Male, Age Groups 21-34 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'AND TargetingSpecAgeGroup IN ('21-24', '25-34') AND TargetingSpecGender = 'MALE'

Canada, Female, 13-20, iOS 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'ca' AND TargetingSpecMinAge = '13' AND TargetingSpecMaxAge = '20' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecDeviceOSType = 'iOS'

UK, Male+Female, Age 25, WIFI Only 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'uk' AND TargetingSpecMinAge = '25' AND TargetingSpecMaxAge = '25' AND TargetingSpecDeviceConnectionType = 'WIFI'

United States - All States Except Arizona or Texas, M+F, All Ages 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND (TargetingSpecCountryCode = 'us' AND NOT(TargetingSpecCountryCode = 'us' AND TargetingSpecRegionId IN (3, 44)))

United States, Female, 18-34, 'Fashion & Style Gurus' OR 'Film & TV Fans' 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecAgeGroup IN ('18-20', '21-24', '25-34') AND TargetingSpecInterestCategoryId IN ('SLC_7', 'SLC_8')

United States, All genders/ages, 'Comedy Fans' 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'SLC_36'

United States, Male, 18-20, member of SAM segment ID '12345' 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND TargetingSpecSegmentId = '12345'

United States, Male, 18-20, NOT a member of SAM segment ID '98765' 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND NOT TargetingSpecSegmentId = '98765'

United States, AT&T 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceCarrierId = 'US_ATT'

United States, 21-24, (College Graduates OR Married People), Apparel Shoppers 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'DLXS_1' AND TargetingSpecAdvancedDemographics IN ('DLXD_100', 'DLXD_300') AND TargetingSpecAgeGroup = '21-24' AND TargetingSpecRegulatedContent = false

United States, metros New York or Los Angeles only 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecMetroId IN ('501', '803')

USA, Female, Spanish speaking, 13-17, iOS version 10.3.2 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecAgeGroup = '13-17' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecLanguage = 'es' AND TargetingSpecDeviceOSType = 'ios' AND TargetingSpecDeviceOSVersionMin = '9.0' AND TargetingSpecDeviceOSVersionMax = '10.3.2'

Zipcode Targeting 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecZipCode IN ('90291', '90026')

Device Make: All iPhone 7 plus and iPhone 6s Plus users 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceMake IN ('Apple/iPhone 7 Plus/', 'Apple/iPhone 6s Plus/')

Location Categories: Targeting Sports Arenas, Fitness Centers 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecLocationCategoryId IN ('LOI_15004', 'LOI_15002') AND TargetingSpecLocationProximityUnit = 'MILES' AND TargetingSpecLocationProximity = 1

Location Point Radius: Targeting 500 meter radius around Nordstrom locations in Seattle/Bellevue 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND ((TargetingSpecLatitude = 47.612447 AND TargetingSpecLongitude = -122.336751 AND TargetingSpecRadius = 500) OR (TargetingSpecLatitude = 47.617102 AND TargetingSpecLongitude = -122.203961 AND TargetingSpecRadius = 50 AND TargetingSpecUnit = 'KILOMETERS'))

Multi-country targeting: Targeting the US and Canada 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' OR TargetingSpecCountryCode = 'ca'

Snap Lifestyle Category inclusion of SLC_1, SLC_124 and exclusion of SLC_2 

SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND (TargetingSpecInterestCategoryId IN ('SLC_1', 'SLC_124') AND NOT TargetingSpecInterestCategoryId = 'SLC_2')

Columns

Name Type References Description
Id [KEY] String The insight Id.
AccountId String

Accounts.Id

The account Id.
Name String The insight name.
DimensionCategory String The dimension category of the insight.
Distribution String The distribution type of the insight.
TargetAudienceSizeMinimum String The minimum size of the target audience.
TargetAudienceSizeMaximum String The maximum size of the target audience.
ReferenceAudienceSizeMinimum String The minimum size of the target Reference.
ReferenceAudienceSizeMaximum String The maximum size of the target audience.
TargetAudiencePercent Decimal The target audience percent.
ReferenceAudiencePercent Decimal The reference audience percent.
TargetIndexToReference Decimal The target index to reference.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
BaseSpecAgeGroup String Age group targeting option.
TargetingSpecAgeGroup String Age group targeting option.
BaseSpecMinAge String Minimum age targeting option.
TargetingSpecMinAge String Minimum age targeting option.
BaseSpecMaxAge String Maximum targeting option.
TargetingSpecMaxAge String Maximum targeting option.
BaseSpecGender String Gender targeting option.
TargetingSpecGender String Gender targeting option.
BaseSpecLanguage String Language targeting option.
TargetingSpecLanguage String Language targeting option.
BaseSpecAdvancedDemographics String Advanced demographics targeting option.
TargetingSpecAdvancedDemographics String Advanced demographics targeting option.
BaseSpecDeviceConnectionType String Device connection type targeting option.
TargetingSpecDeviceConnectionType String Device connection type targeting option.
BaseSpecDeviceOSType String Device OS type targeting option.
TargetingSpecDeviceOSType String Device OS type targeting option.
BaseSpecDeviceOSVersionMin String Device OS min version targeting option.
TargetingSpecDeviceOSVersionMin String Device OS min version targeting option.
BaseSpecDeviceOSVersionMax String Device OS max version targeting option.
TargetingSpecDeviceOSVersionMax String Device OS max version targeting option.
BaseSpecDeviceCarrierId String Device carrier ID targeting option.
TargetingSpecDeviceCarrierId String Device carrier ID targeting option.
BaseSpecDeviceMake String Device make targeting option.
TargetingSpecDeviceMake String Device make targeting option.
BaseSpecCountryCode String Country code targeting option.
TargetingSpecCountryCode String Country code targeting option.
BaseSpecRegionId String Region/State ID targeting option.
TargetingSpecRegionId String Region/State ID targeting option.
BaseSpecMetroId String Metro/DMA ID targeting option.
TargetingSpecMetroId String Metro/DMA ID targeting option.
BaseSpecZipCode String ZipCode targeting option.
TargetingSpecZipCode String ZipCode targeting option.
BaseSpecLocationCategoryId String Location category ID targeting option.
TargetingSpecLocationCategoryId String Location category ID targeting option.
BaseSpecLocationProximity Int Proximity to selected location categories.
TargetingSpecLocationProximity Int Proximity to selected location categories.
BaseSpecLocationProximityUnit String Unit to be used for radius.
TargetingSpecLocationProximityUnit String Unit to be used for radius.
BaseSpecLatitude Decimal Latitude in decimal degrees.
TargetingSpecLatitude Decimal Latitude in decimal degrees.
BaseSpecLongitude Decimal Longitude in decimal degrees.
TargetingSpecLongitude Decimal Longitude in decimal degrees.
BaseSpecRadius Int Radius in meters (minimum 96 meters and maximum 100000 meters).
TargetingSpecRadius Int Radius in meters (minimum 96 meters and maximum 100000 meters).
BaseSpecUnit String Unit to be used for radius.
TargetingSpecUnit String Unit to be used for radius.
BaseSpecSegmentId String Segment ID targeting option.
TargetingSpecSegmentId String Segment ID targeting option.
BaseSpecInterestCategoryId String Interest category ID targeting option.
TargetingSpecInterestCategoryId String Interest category ID targeting option.
BaseSpecRegulatedContent Bool Flag to mark content within the Ad Squad as Regulated Content.
TargetingSpecRegulatedContent Bool Flag to mark content within the Ad Squad as Regulated Content.
BaseSpecEnableTargetingExpansion Bool Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting.
TargetingSpecEnableTargetingExpansion Bool Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting.

CData Cloud

CampaignStats

Lists all campaign stats.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • AccountId supports the following operators: =,IN
  • CampaignId supports the following operators: =,IN
  • StartTime supports the following operator: =
  • EndTime supports the following operator: =
  • Granularity supports the following operator: =
  • Dimension supports the following operator: =
  • SwipeUpAttributionWindow supports the following operator: =
  • ViewAttributionWindow supports the following operator: =
  • ConversionSourceTypes supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'

    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
    SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'

Note: You must specify either AccountId or CampaignId. If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.

If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.

Dimension Dimension Category
Country geos
Region geos
DMA geos
Gender demographics
Age demographics
InterestCategoryId interests
InterestCategoryName interests
OS devices
Make devices

Columns

Name Type References Description
AccountId String

Accounts.Id

The account Id.
CampaignId String

Campaigns.Id

The campaign Id.
StartTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Datetime Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
FinalizedDataEndTime Datetime This defines the time up until when 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 FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly.
IntervalStartTime Datetime Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime Datetime End time of the current interval. This applies only to Granularity DAY and HOUR.
Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.
Dimension String You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined.
SwipeUpAttributionWindow String Attribution window for swipe ups.
ViewAttributionWindow String Attribution window for views.
Country String ISO country code.
Region String Region.
DMA Int DMA numeric code.
Gender String Gender.
Age String Age bucket.
InterestCategoryId String SnapchatAds User Lifestyle Interest Category Id.
InterestCategoryName String SnapchatAds User Lifestyle Interest Category Name.
OS String Device Operating System.
Make String Device Make (e.g., Apple, Samsung)
Impressions Int Impression Count.
Swipes Int Swipe-Up Count.
ViewTimeMillis Long Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds).
ScreenTimeMillis Long Total Time Spent on top Snap Ad (milliseconds).
Quartile1 Int Video Views to 25%.
Quartile2 Int Video Views to 50%.
Quartile3 Int Video Views to 75%.
ViewCompletion Int Video Views to completion.
Spend Decimal Amount Spent.
VideoViews Int 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.
AndroidInstalls Int Number of Android App Installs.
AndroidInstallsApp Int Number of Android App Installs.
AndroidInstallsWeb Int Number of Android App Installs.
AndroidInstallsSwipeUp Int Number of Android App Installs.
AndroidInstallsAppSwipeUp Int Number of Android App Installs.
AndroidInstallsWebSwipeUp Int Number of Android App Installs.
AndroidInstallsView Int Number of Android App Installs.
AndroidInstallsAppView Int Number of Android App Installs.
AndroidInstallsWebView Int Number of Android App Installs.
AttachmentAvgViewTimeMillis Long Average Attachment View Time (milli-seconds).
AttachmentFrequency Double Average number of Attachment Views per User Reached.
AttachmentQuartile1 Int Long Form Video Views to 25%.
AttachmentQuartile2 Int Long Form Video Views to 50%.
AttachmentQuartile3 Int Long Form Video Views to 75%.
AttachmentTotalViewTimeMillis Long Total Attachment View Time (milli-seconds).
AttachmentUniques Int Number of unique attachment impressions.
AttachmentViewCompletion Int Long Form Video Views to completion.
AttachmentVideoViews Int Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration.
AvgViewTimeMillis Long Use avg_screen_time_millis instead. Average Top Snap view time per User Reached.
AvgScreenTimeMillis Long Average Top Snap view time across all impressions.
Frequency Double Average number of Impressions per User Reached.
IosInstalls Int Number of iOS App Installs.
IosInstallsApp Int Number of iOS App Installs.
IosInstallsWeb Int Number of iOS App Installs.
IosInstallsSwipeUp Int Number of iOS App Installs.
IosInstallsAppSwipeUp Int Number of iOS App Installs.
IosInstallsWebSwipeUp Int Number of iOS App Installs.
IosInstallsView Int Number of iOS App Installs.
IosInstallsAppView Int Number of iOS App Installs.
IosInstallsWebView Int Number of iOS App Installs.
SwipeUpPercent Double % of Impressions that Swiped-Up.
TotalInstalls Int Total number of App Installs.
TotalInstallsApp Int Total number of App Installs.
TotalInstallsWeb Int Total number of App Installs.
TotalInstallsSwipeUp Int Total number of App Installs.
TotalInstallsAppSwipeUp Int Total number of App Installs.
TotalInstallsWebSwipeUp Int Total number of App Installs.
TotalInstallsView Int Total number of App Installs.
TotalInstallsAppView Int Total number of App Installs.
TotalInstallsWebView Int Total number of App Installs.
Uniques Int Number of unique impressions.
VideoViewsTimeBased Int The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups.
VideoViews15s Int 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.
StoryOpens Int Number of times users tapped on the ad tile in the feed to view the Story Ad.
StoryCompletes Int Number of times users viewed through to the last Snap of your Story Ad.
PositionImpressions Int The impression number for this story ad position.
PositionUniques Int The unique viewer numbers for this story ad position.
PositionFrequency Double The frequency for this story ad position.
PositionScreenTimeMillis Long The total view time in milliseconds for this story ad position.
PositionSwipeUpPercent Double The swipe up rate for this story ad position.
AvgPositionScreenTimeMillis Long The average view time for this story ad position.
Shares Int Number of times lens/filter was shared in a Chat or Story.
Saves Int Number of times lens/filter was saved to Memories.
ConversionPurchases Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValue Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSave Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckout Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCart Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContent Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBilling Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUps Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearches Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletes Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpens Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViews Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribe Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClick Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorial Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInvite Int Number of attributed 'INVITE' conversion events.
ConversionLogin Int Number of attributed 'LOGIN' conversion events.
ConversionShare Int Number of attributed 'SHARE' conversion events.
ConversionReserve Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlocked Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlist Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCredits Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRate Int Number of attributed 'RATE' conversion events.
ConversionStartTrial Int Number of attributed 'START_TRIAL' conversion events.
ConversionListView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1 Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2 Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3 Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4 Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5 Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1SwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2SwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3SwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4SwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5SwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteView Int Number of attributed 'INVITE' conversion events.
ConversionLoginView Int Number of attributed 'LOGIN' conversion events.
ConversionShareView Int Number of attributed 'SHARE' conversion events.
ConversionReserveView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1View Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2View Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3View Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4View Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5View Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesApp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueApp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveApp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutApp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartApp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentApp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingApp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsApp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesApp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesApp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensApp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsApp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeApp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickApp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewApp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialApp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteApp Int Number of attributed 'INVITE' conversion events.
ConversionLoginApp Int Number of attributed 'LOGIN' conversion events.
ConversionShareApp Int Number of attributed 'SHARE' conversion events.
ConversionReserveApp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedApp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistApp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsApp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateApp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialApp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewApp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1App Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2App Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3App Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4App Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5App Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesAppView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueAppView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveAppView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutAppView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartAppView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentAppView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingAppView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsAppView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesAppView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesAppView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensAppView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsAppView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeAppView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickAppView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewAppView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialAppView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteAppView Int Number of attributed 'INVITE' conversion events.
ConversionLoginAppView Int Number of attributed 'LOGIN' conversion events.
ConversionShareAppView Int Number of attributed 'SHARE' conversion events.
ConversionReserveAppView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedAppView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistAppView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsAppView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateAppView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialAppView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewAppView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1AppView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2AppView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3AppView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4AppView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5AppView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWeb Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWeb Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWeb Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWeb Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWeb Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWeb Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWeb Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWeb Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWeb Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWeb Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWeb Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWeb Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWeb Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWeb Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWeb Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWeb Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWeb Int Number of attributed 'INVITE' conversion events.
ConversionLoginWeb Int Number of attributed 'LOGIN' conversion events.
ConversionShareWeb Int Number of attributed 'SHARE' conversion events.
ConversionReserveWeb Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWeb Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWeb Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWeb Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWeb Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWeb Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWeb Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1Web Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2Web Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3Web Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4Web Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5Web Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebSwipeUp Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebSwipeUp Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebSwipeUp Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebSwipeUp Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebSwipeUp Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebSwipeUp Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebSwipeUp Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebSwipeUp Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebSwipeUp Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebSwipeUp Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebSwipeUp Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebSwipeUp Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebSwipeUp Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebSwipeUp Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebSwipeUp Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebSwipeUp Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebSwipeUp Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebSwipeUp Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebSwipeUp Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebSwipeUp Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebSwipeUp Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebSwipeUp Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebSwipeUp Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebSwipeUp Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebSwipeUp Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebSwipeUp Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebSwipeUp Int Number of attributed 'CUSTOM_EVENT_5' conversion events.
ConversionPurchasesWebView Int Number of attributed 'PURCHASE' conversion events.
ConversionPurchasesValueWebView Decimal Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency).
ConversionSaveWebView Int Number of attributed 'SAVE' conversion events.
ConversionStartCheckoutWebView Int Number of attributed 'START_CHECKOUT' conversion events.
ConversionAddCartWebView Int Number of attributed 'ADD_CART' conversion events.
ConversionViewContentWebView Int Number of attributed 'VIEW_CONTENT' conversion events.
ConversionAddBillingWebView Int Number of attributed 'ADD_BILLING' conversion events.
ConversionSignUpsWebView Int Number of attributed 'SIGN_UP' conversion events.
ConversionSearchesWebView Int Number of attributed 'SEARCH' conversion events.
ConversionLevelCompletesWebView Int Number of attributed 'LEVEL_COMPLETE' conversion events.
ConversionAppOpensWebView Int Number of attributed 'APP_OPEN' conversion events.
ConversionPageViewsWebView Int Number of attributed 'PAGE_VIEW' conversion events.
ConversionSubscribeWebView Int Number of attributed 'SUBSCRIBE' conversion events.
ConversionAdClickWebView Int Number of attributed 'AD_CLICK' conversion events.
ConversionAdViewWebView Int Number of attributed 'AD_VIEW' conversion events.
ConversionCompleteTutorialWebView Int Number of attributed 'COMPLETE_TUTORIAL' conversion events.
ConversionInviteWebView Int Number of attributed 'INVITE' conversion events.
ConversionLoginWebView Int Number of attributed 'LOGIN' conversion events.
ConversionShareWebView Int Number of attributed 'SHARE' conversion events.
ConversionReserveWebView Int Number of attributed 'RESERVE' conversion events.
ConversionAchievementUnlockedWebView Int Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events.
ConversionAddToWishlistWebView Int Number of attributed 'ADD_TO_WISHLIST' conversion events.
ConversionSpendCreditsWebView Int Number of attributed 'SPENT_CREDITS' conversion events.
ConversionRateWebView Int Number of attributed 'RATE' conversion events.
ConversionStartTrialWebView Int Number of attributed 'START_TRIAL' conversion events.
ConversionListViewWebView Int Number of attributed 'LIST_VIEW' conversion events.
CustomEvent1WebView Int Number of attributed 'CUSTOM_EVENT_1' conversion events.
CustomEvent2WebView Int Number of attributed 'CUSTOM_EVENT_2' conversion events.
CustomEvent3WebView Int Number of attributed 'CUSTOM_EVENT_3' conversion events.
CustomEvent4WebView Int Number of attributed 'CUSTOM_EVENT_4' conversion events.
CustomEvent5WebView Int Number of attributed 'CUSTOM_EVENT_5' conversion events.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ConversionSourceTypes String Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total'
RetrieveSampleStats Bool Whether to return sample (fake) stats or not.

CData Cloud

Creatives

Retrieves all creatives associated with an ad account

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =
  • AccountId supports the following operator: =; If no value is specified, the Cloud will try to get the first Account from the list returned by the Accounts view.
The following queries are processed server side: 
    SELECT * FROM Creatives WHERE Id = 'c1e6e929-acec-466f-b023-852b8cacc18f'
    SELECT * FROM Creatives WHERE AccountId = '331deb8082b8-a1d5-4579-9f7c-2e874d37'

Columns

Name Type References Description
Id [KEY] String ID of the creative.
UpdatedAt Datetime The date when the entity was last updated.
CreatedAt Datetime The creation date of the entity.
Name String Creative name.
Headline String Creative headline.
AccountId String

Accounts.Id

Creative Account ID.
Type String Creative type.

The allowed values are SNAP_AD, APP_INSTALL, LONGFORM_VIDEO, WEB_VIEW, DEEP_LINK, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, PREVIEW, COMPOSITE, FILTER, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, LENS_LONGFORM_VIDEO, COLLECTION.

PackagingStatus String Packaging Status.

The allowed values are PENDING, SUCCESS, IN_PROGRESS.

ReviewStatus String Review Status.
Shareable Boolean Allow Users to Share with Friends
TopSnapMediaId String Top Snap Media ID.
CallToAction String Call to Action.

The allowed values are BLANK, INSTALL_NOW, WATCH, VIEW_MORE, WATCH_EPISODE, DOWNLOAD, PLAY, SHOP_NOW, SIGN_UP, USE_APP, APPLY_NOW, BOOK_NOW, BUY_TICKETS, GET_NOW, LISTEN, MORE, ORDER_NOW, READ, SHOW, SHOWTIMES, VIEW, OPEN_APP, TRY.

TopSnapCropPosition String Top Snap Crop Position.

The allowed values are OPTIMIZED, MIDDLE, TOP, BOTTOM.

LongformVideoProperties String Long Form Video Properties.
AppInstallProperties String App Install Properties.
WebViewProperties String Web View Properties.

CData Cloud

DemographicsAgeGroups

Lists all age group targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DemographicsAgeGroups

Columns

Name Type References Description
Id [KEY] String ID of the target option.
Name String The name of the target option.

CData Cloud

DemographicsGender

Lists all gender targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DemographicsGender

Columns

Name Type References Description
Id [KEY] String ID of the target option.
Name String The name of the target option.

CData Cloud

DemographicsLanguages

Lists all language targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DemographicsLanguages

Columns

Name Type References Description
Id [KEY] String ID of the target option.
Name String The name of the target option.

CData Cloud

DeviceCarriers

Lists all device carrier targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DeviceCarriers

Columns

Name Type References Description
Id [KEY] String The ID of the targeting option.
Name String The name of the targeting option.
ValidCountry String The valid country of the targeting option.

CData Cloud

DeviceConnectionTypes

Lists all device connection type targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DeviceConnectionTypes

Columns

Name Type References Description
Id [KEY] String The ID of the target option.
Name String The name of the target option.

CData Cloud

DeviceMakes

Lists all device make targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DeviceMakes

Columns

Name Type References Description
Id [KEY] String The ID of the targeting option.
Name String The name of the targeting option.

CData Cloud

DeviceOSTypes

Lists all device OS type targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DeviceOSTypes

Columns

Name Type References Description
Id [KEY] String The ID of the targeting option.
Name String The name of the targeting option.

CData Cloud

DeviceOSVersions

Lists all device OS version targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM DeviceOSVersions

Columns

Name Type References Description
Id [KEY] String The ID of the targeting option.
DeviceOSType String

DeviceOSTypes.Name

The device OS type.
Name String The name of the targeting option.

CData Cloud

FundingSources

Lists all funding sources for the specified Organization.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
  • OrganizationId supports the following operators: =,IN; If no value is specified, the Cloud will try to get the first organization from the list returned by the Organizations view.
The following queries are processed server side: 
    SELECT * FROM FundingSources WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
    SELECT * FROM FundingSources WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37') 
    SELECT * FROM FundingSources WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM FundingSources WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-69b96ded-4871-4750-8f19507f6bdd')

Columns

Name Type References Description
Id [KEY] String ID of the funding source.
OrganizationId String

Organizations.Id

The id of the organization.
CreatedAt Datetime Date of creation.
UpdatedAt Datetime Date of last update.
Type String Funding Source type.

The allowed values are LINE_OF_CREDIT, CREDIT_CARD, COUPON, PAYPAL.

Status String Status of the funding source.

The allowed values are ACTIVE, REDEEMED, SPENT, EXPIRED, DELETED.

BudgetSpent Decimal Budget Spent.
Currency String Account currency.

The allowed values are USD, CAD, GBP, AUD, EUR.

TotalBudget Decimal Total Budget.
AvailableCredit Decimal Total available credit.
CardType String Credit Card Type.

The allowed values are AMEX, DINERS_CLUB, DISCOVER, JCB, MAESTRO, MASTERCARD, VISA, UNKNOWN.

Name String Name of the Credit Card.
Last4 Int Last 4 digits of the Credit Card.
ExpirationYear Int Expiration year of the Credit Card.
ExpirationMonth Int Expiration month of the Credit Card.
DailySpendLimit Decimal Daily spend limit for Credit Card.
DailySpendLimitCurrency String Currency for the DailySpendLimit.

The allowed values are USD, CAD, GBP, AUD, EUR.

Value Decimal Value of the COUPON.
StartDate Datetime Start date of the COUPON.
EndDate Datetime End date of the COUPON.
Email String Email associated with Paypal.

CData Cloud

GeolocationCountries

Lists all country targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM GeolocationCountries

Columns

Name Type References Description
Id [KEY] String The ID of the country.
Name String The country name.
Code String The country code.
Latitude Decimal The country latitude.
Longitude Decimal The country longitude.
ContinentId String The continent ID.
ContinentName String The name of the continent.

CData Cloud

GeolocationMetros

Lists all metro/dma targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CountryCode supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM GeolocationMetros WHERE CountryCode = 'ca'

Columns

Name Type References Description
Id [KEY] String The ID of the metro.
CountryCode String

GeolocationCountries.Code

The country code.

The default value is us.

Name String The metro name.
Regions String The metro regions.
Latitude Decimal The metro latitude.
Longitude Decimal The metro longitude.

CData Cloud

GeolocationRegions

Lists all region/state targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CountryCode supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM GeolocationRegions WHERE CountryCode = 'ca'

Columns

Name Type References Description
Id [KEY] String The ID of the region.
CountryCode String

GeolocationCountries.Code

The country code.

The default value is us.

Name String The region name.
Code String The region code.
Latitude Decimal The region latitude.
Longitude Decimal The region longitude.

CData Cloud

GeolocationZipCodes

Lists all of zipcode targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CountryCode supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM GeolocationZipCodes WHERE CountryCode = 'ca'

Columns

Name Type References Description
Code [KEY] String The zip code.
CountryCode String

GeolocationCountries.Code

The country code.

The default value is us.

CityName String The city name.

CData Cloud

Invoices

Lists all invoices for a given Ad Account.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =
  • AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Cloud will try to get the first account from the list returned by the Accounts view.
The following queries are processed server side: 
    SELECT * FROM Invoices WHERE AccountId = '4b591696-3017-4852-85d2-dc7d50157153'
    SELECT * FROM Invoices WHERE AccountId = '4b591696-3017-4852-85d2-dc7d50157153' AND Id = '861b7c55-7e35-4348-918f-3758db350b80'

Columns

Name Type References Description
Id [KEY] String Invoice ID.
AccountId [KEY] String

Accounts.Id

Ad Account ID.
OrganizationId String

Organizations.Id

The ID of the organization.
NetsuiteFileId String Snap Internal ID.
CustomerName String Customer name.
CustomerNetsuiteId String Snap Internal ID.
DocumentNumber Int Document number.
LineLastModified Datetime The date when the line was last updated.
LastModified Datetime The date when the invoice was last updated.
Amount Decimal Invoice amount.
Currency String Currency of the invoice.

The allowed values are AUD, CAD, EUR, GBP, USD, SEK, DKK, NOK.

BillingPeriod String Specifies the billing period.
DueDate Datetime Due date of the invoice.
CreatedAt Datetime The creation date of the invoice.
InvoiceStatus String Indicates whether the invoice has been collected.

The allowed values are COLLECTED, SENT_FOR_COLLECTION.

InvoiceContent String Bytestream (Base64), this Bytestream can turned into a PDF.

CData Cloud

LocationCategories

Lists all location categories.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM LocationCategories

Columns

Name Type References Description
Id [KEY] String The ID of the location category.
Name String The location category name.
ParentId String The parent id of the location category.
Path String The path of the location category.
Source String The source of the location category.

CData Cloud

NielsenInterests

Lists all Nielsen Interests targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM NielsenInterests

Columns

Name Type References Description
Id [KEY] String The ID of the Nielsen interest.
Name String The Nielsen interest name.
ParentId String The parent Id of the Nielsen interest.
Path String The path of the Nielsen interest.
Source String The source of the Nielsen interest.

CData Cloud

Organizations

Lists all the organizations where the authenticated user has access.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • Id supports the following operator: =,IN
The following queries are processed server side: 
    SELECT * FROM Organizations WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
    SELECT * FROM Organizations WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-69b96ded-4871-4750-8f19507f6b')

Columns

Name Type References Description
Id [KEY] String Unique identifier of the organization.
Name String The organization name.
CreatedAt Datetime Identifies the date and time when the organization was created.
UpdatedAt Datetime Identifies the date and time when the organization was updated.
AddressLine1 String Address line 1.
Locality String Locality.
AdministrativeDistrictLevel1 String AdministrativeDistrictLevel.
Country String Country.
PostalCode String Zip/Postal Code.
ContactEmail String Contact email.
ContactName String Contact name.
ContactPhone String Contact phone.
Type String The organization type.
State String The organization state.
Roles String Roles.
ConfigurationSettings String Configuration settings.

CData Cloud

PlacedVisitationSegmentsInterests

Lists all interest targeting based on Placed Visitation Segments.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. The following queries are processed server side: 

    SELECT * FROM PlacedVisitationSegmentsInterests

Columns

Name Type References Description
Id [KEY] String The ID of the interest.
Name String The interest name.
ParentId String The parent id of the interest.
Path String The path of the interest.
Source String The source of the interest.

CData Cloud

SnapLifeStyleCategoriesInterests

Lists all Snap Lifestyle Categories targeting options.

Select

The Cloud will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

  • CountryCode supports the following operator: =
The following queries are processed server side: 
    SELECT * FROM SnapLifeStyleCategoriesInterests WHERE CountryCode = 'ca'

Columns

Name Type References Description
Id [KEY] String The ID of the targeting option.
CountryCode String

GeolocationCountries.Code

The country code.
Name String The name of the lifestyle category.
ParentId String The parent ID of the lifestyle category.
Path String The path of the lifestyle category.
Source String The source of the lifestyle category.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Snapchat Ads.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Snapchat Ads, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Snapchat Ads Stored Procedures

Name Description
AddAudienceSegmentUsers Add specific users to an audience segment.
CreateLookalikeSegment Create a Snap Audience Match Lookalike Segment within a specified ad account.
RemoveAudienceSegmentUsers Remove specific users or all users from specified Snap Audience Match segment

CData Cloud

AddAudienceSegmentUsers

Add specific users to an audience segment.

Execute

You can add users to a specific audience segment by specifying a list of identifiers: 

EXECUTE AddAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', Identifiers = '001-234-567-8910,+44 844 412 4653'

You can add users to a specific audience segment by specifying a CSV file with a list of identifiers: 

EXECUTE AddAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', CSVFilePath = 'C:\\identifiers.csv'

Input

Name Type Required Description
AudienceSegmentId String True The Id of the audience segment.
IdentifierType String True The identifier type.

The allowed values are EMAIL, MOBILE_ADVERTISER_ID, PHONE.

Identifiers String False Comma-separated list of email, phone number or mobile identifiers.
CSVFilePath String False The path of the csv file.

Result Set Columns

Name Type Description
Success Bool Whether the request was successful or not.
NumberOfUploadedUsers Int The number of the uploaded users.

CData Cloud

CreateLookalikeSegment

Create a Snap Audience Match Lookalike Segment within a specified ad account.

Execute


EXECUTE CreateLookalikeSegment AccountId = '8adc3db7-8148-4fbf-999c-8d2266369d74', SeedSegmentId = '5677923948298240', Country = 'US', Type = 'REACH', Name = 'lookalikes of all the sams in the world', Description = 'similar to all the sams in the world', RetentionInDays = '180'

Input

Name Type Required Description
AccountId String True Ad Account ID.
SeedSegmentId String True Seed Audience Segment ID.
Country String True ISO-2 Country Code.
Type String False The type of Lookalike to be created.

The allowed values are BALANCE, SIMILARITY, REACH.

The default value is BALANCE.

Name String True Audience Segment name.
RetentionInDays Int True Number of days to retain audience members.
Description String False Audience Segment Description.

Result Set Columns

Name Type Description
SegmentId String The ID of the newly created Lookalike Segment.

CData Cloud

RemoveAudienceSegmentUsers

Remove specific users or all users from specified Snap Audience Match segment

Execute

You can remove users from a specific audience segment by specifying a list of identifiers: 

EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', Identifiers = '001-234-567-8910,+44 844 412 4653'

You can remove users from a specific audience segment by specifying a CSV file with a list of identifiers: 

EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', CSVFilePath = 'C:\\identifiers.csv'

You can also remove all users from a specific audience segment: 

EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', RemoveAllUsers = true

Input

Name Type Required Description
AudienceSegmentId String True The Id of the audience segment.
IdentifierType String False The identifier type.

The allowed values are EMAIL, MOBILE_ADVERTISER_ID, PHONE.

Identifiers String False Comma-separated list of email, phone number or mobile identifiers.
CSVFilePath String False The path of the csv file.
RemoveAllUsers Bool False Whether to delete all users or not.

Result Set Columns

Name Type Description
Success Bool Whether the request was successful or not.
NumberOfUploadedUsers Int The number of the uploaded users.

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Snapchat Ads:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string: 

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas: 

          SELECT * FROM sys_schemas

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views: 

          SELECT * FROM sys_tables

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Campaigns table: 

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Campaigns'

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures: 

          SELECT * FROM sys_procedures

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RemoveAudienceSegmentUsers stored procedure: 

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RemoveAudienceSegmentUsers' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True: 

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RemoveAudienceSegmentUsers' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native Snapchat Ads procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Campaigns table: 

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Campaigns'

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables: 

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views: 

         SELECT * FROM sys_primarykeys

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys: 

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value: 

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause: 

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation: 

         SELECT * FROM sys_identity

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns: 

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

PropertyDescription
AccountIdIdentifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view.

OAuth

PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the number of concurrent requests.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RetrieveSampleStatsWhether to return sample (fake) stats or not.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

PropertyDescription
AccountIdIdentifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view.
CData Cloud

AccountId

Identifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view.

Data Type

string

Default Value

""

Remarks

This Id is used to get analytic stats for the account that is identified by this Id. The Accounts view can be used to list available accounts with their specific Ids. If left empty the driver will try to get the first account from the list returned by the Accounts view.

CData Cloud

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the number of concurrent requests.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RetrieveSampleStatsWhether to return sample (fake) stats or not.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

MaxThreads

Specifies the number of concurrent requests.

Data Type

string

Default Value

"20"

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

The Snapchat Ads API has a rate limit of 10000 requests per minute for Snapchat Ads Professional plans and 25000 per minute for the Snapchat Ads Premium plans.

Because of the Snapchat Ads API limits, the Cloud is restricted to making an http request for each row in order to collect as much data as possible.

To improve the performance of the Cloud consider increasing this value based on the machine's resources.

CData Cloud

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from Snapchat Ads, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: 

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use: 

*=*

CData Cloud

RetrieveSampleStats

Whether to return sample (fake) stats or not.

Data Type

bool

Default Value

false

Remarks

Set to false to exclude sample stats.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434