Skip to main content

Snapchat Marketing

Overview

The Snapchat Marketing source can sync data from the Snapchat Marketing API

Useful links:

Output schema

This Source is capable of syncing the following Streams:

Data type mapping

Integration TypeAirbyte TypeNotes
stringstring
integerinteger
numbernumber
arrayarray
objectobject
booleanboolean

Features

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
NamespacesNo

Requirements

  • client_id - Snapchat account client ID
  • client_secret - Snapchat account client secret
  • refresh_token - Snapchat account refresh token

Setup guide

To get the required credentials you need to set up a snapchat business account. Follow this guide to set up one:

Snapchat uses OAuth2 authentication, so to get the refresh token the workflow in next: 1. Open the authorize link in a browser: https://accounts.snapchat.com/login/oauth2/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope=snapchat-marketing-api&state=wmKkg0TWgppW8PTBZ20sldUmF7hwvU

  1. Login & Authorize via UI

  2. Locate "code" query parameter in the redirect

  3. Exchange code for access token + refresh token

    curl -X POST \  
    -d "code={one_time_use_code}" \
    -d "client_id={client_id}" \
    -d "client_secret={client_secret}" \
    -d "grant_type=authorization_code" \
    -d "redirect_uri=redirect_uri"
    https://accounts.snapchat.com/login/oauth2/access_token

You will receive the API key and refresh token in response. Use this refresh token in the connector specifications.
The useful link to Authentication process is here

Performance considerations

Snapchat Marketing API has limitations to 1000 items per page

Changelog

VersionDatePull RequestSubject
0.1.42021-12-078429Update titles and descriptions
0.1.32021-11-107811Add oauth2.0, fix stream_state
0.1.22021-11-087499Remove base-python dependencies
0.1.12021-07-295072Fix bug with incorrect stream_state value
0.1.02021-07-264843Initial release supporting the Snapchat Marketing API