Snapchat Ads API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "snapchat_ads",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"sync_mode": "SpecificOrganizations | AllOrganizations",
"view_attribution_window": "DAY_1 | HOUR_6 | HOUR_3 | HOUR_1 | DAY_7 | NONE | DAY_28",
"swipe_attribution_window": "DAY_1 | DAY_7 | DAY_28",
"timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
"organizations": [
"string"
],
"accounts": [
"string"
],
"custom_reports": [
{
"sk_ad_metrics_fields": [
"custom_event_2_sk_ad_network_view | conversion_invite_sk_ad_network_total | custom_event_4_sk_ad_network | conversion_list_view_sk_ad_network_view | conversion_share_sk_ad_network_total | conversion_ad_click_sk_ad_network | conversion_save_sk_ad_network_view | conversion_sign_ups_sk_ad_network_total | conversion_start_trial_sk_ad_network_total | conversion_start_trial_sk_ad_network | conversion_purchases_sk_ad_network_view | conversion_subscribe_sk_ad_network_view | conversion_level_completes_sk_ad_network_view | conversion_spend_credits_sk_ad_network_view | conversion_level_completes_sk_ad_network | conversion_add_billing_sk_ad_network_view | unknown_sk_ad_network_view | conversion_ad_view_sk_ad_network | custom_event_5_sk_ad_network_total | conversion_rate_sk_ad_network_view | conversion_view_content_sk_ad_network | conversion_login_sk_ad_network_total | conversion_reserve_sk_ad_network_view | conversion_app_opens_sk_ad_network_total | conversion_spend_credits_sk_ad_network | conversion_achievement_unlocked_sk_ad_network_total | conversion_reserve_sk_ad_network_total | conversion_complete_tutorial_sk_ad_network | conversion_ad_click_sk_ad_network_total | conversion_add_cart_sk_ad_network | conversion_ios_installs_sk_ad_network | conversion_assist_install_sk_ad_network_view | conversion_view_content_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_view | conversion_start_trial_sk_ad_network_view | conversion_add_billing_sk_ad_network | conversion_list_view_sk_ad_network | conversion_subscribe_sk_ad_network_total | conversion_null_sk_ad_network | conversion_total_installs_sk_ad_network | conversion_sign_ups_sk_ad_network | conversion_list_view_sk_ad_network_total | conversion_app_opens_sk_ad_network | conversion_sign_ups_sk_ad_network_view | conversion_achievement_unlocked_sk_ad_network | unknown_sk_ad_network | conversion_page_views_sk_ad_network_total | conversion_ad_view_sk_ad_network_view | custom_event_4_sk_ad_network_view | conversion_searches_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network | conversion_searches_sk_ad_network_view | conversion_ad_view_sk_ad_network_total | conversion_ios_installs_sk_ad_network_view | custom_event_3_sk_ad_network | conversion_save_sk_ad_network_total | conversion_save_sk_ad_network | conversion_add_billing_sk_ad_network_total | conversion_null_sk_ad_network_total | custom_event_5_sk_ad_network | conversion_reserve_sk_ad_network | conversion_page_views_sk_ad_network | conversion_level_completes_sk_ad_network_total | custom_event_1_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_total | conversion_rate_sk_ad_network_total | conversion_start_checkout_sk_ad_network_view | conversion_app_opens_sk_ad_network_view | conversion_spend_credits_sk_ad_network_total | conversion_purchases_sk_ad_network | conversion_share_sk_ad_network_view | custom_event_3_sk_ad_network_total | conversion_ios_installs_sk_ad_network_total | conversion_rate_sk_ad_network | custom_event_1_sk_ad_network_view | custom_event_3_sk_ad_network_view | conversion_add_cart_sk_ad_network_view | conversion_page_views_sk_ad_network_view | conversion_purchases_sk_ad_network_total | custom_event_1_sk_ad_network | conversion_complete_tutorial_sk_ad_network_total | custom_event_4_sk_ad_network_total | conversion_add_cart_sk_ad_network_total | conversion_subscribe_sk_ad_network | conversion_start_checkout_sk_ad_network_total | custom_event_5_sk_ad_network_view | conversion_total_installs_sk_ad_network_view | custom_event_2_sk_ad_network_total | conversion_view_content_sk_ad_network_view | conversion_login_sk_ad_network | conversion_login_sk_ad_network_view | conversion_start_checkout_sk_ad_network | conversion_assist_install_sk_ad_network_total | conversion_achievement_unlocked_sk_ad_network_view | conversion_searches_sk_ad_network | conversion_share_sk_ad_network | conversion_ad_click_sk_ad_network_view | conversion_total_installs_sk_ad_network_total | conversion_assist_install_sk_ad_network | unknown_sk_ad_network_total | conversion_invite_sk_ad_network | conversion_null_sk_ad_network_view | conversion_complete_tutorial_sk_ad_network_view | conversion_invite_sk_ad_network_view | custom_event_2_sk_ad_network"
],
"add_metric_variants": true,
"base_metrics_fields": [
"quartile_2 | quartile_3 | quartile_1 | conversion_searches_value | play_time_millis | conversion_login | avg_screen_time_millis | conversion_page_views | saves | video_views | conversion_list_view | conversion_add_billing_value | conversion_reserve_value | conversion_share | conversion_reserve | conversion_purchases_value | attachment_total_view_time_millis | conversion_add_to_wishlist | avg_position_screen_time_millis | conversion_visit_value | story_completes | conversion_complete_tutorial_value | conversion_start_trial | conversion_start_trial_value | uniques | conversion_subscribe | conversion_save | conversion_add_cart_value | conversion_level_completes | screen_time_millis | total_reach | conversion_invite | total_installs | conversion_achievement_unlocked_value | custom_event_1_value | view_completion | position_impressions | shares | video_views_time_based | conversion_complete_tutorial | conversion_login_value | ios_installs | conversion_subscribe_value | conversion_save_value | native_leads | conversion_rate | avg_view_time_millis | conversion_ad_view | attachment_avg_view_time_millis | earned_impressions | custom_event_1 | impressions | position_screen_time_millis | custom_event_2 | conversion_visit | conversion_spend_credits_value | conversion_add_billing | paid_impressions | conversion_purchases | android_installs | swipes | conversion_start_checkout | conversion_view_content_value | conversion_achievement_unlocked | position_swipe_up_percent | conversion_rate_value | frequency | custom_event_3 | custom_event_4 | custom_event_5 | earned_reach | conversion_start_checkout_value | swipe_up_percent | conversion_spend_credits | profile_clicks | conversion_level_completes_value | conversion_sign_ups | custom_event_5_value | story_opens | conversion_page_views_value | video_views_15s | conversion_add_to_wishlist_value | custom_event_2_value | conversion_ad_click_value | attachment_uniques | attachment_video_views | conversion_list_view_value | conversion_ad_view_value | conversion_sign_ups_value | total_impressions | conversion_app_opens_value | attachment_quartile_1 | landing_page_views | conversion_app_opens | conversion_invite_value | attachment_quartile_3 | spend | attachment_quartile_2 | custom_event_4_value | conversion_add_cart | conversion_searches | attachment_view_completion | view_time_millis | attachment_frequency | conversion_view_content | conversion_share_value | custom_event_3_value | conversion_ad_click"
],
"breakout": "app | offline | total | total_on_platform | web | total_off_platform",
"granularity": "HOUR | DAY",
"breakdown": "AD | AD_SQUAD | CAMPAIGN",
"report_name": "some_report_name",
"dimension": "COUNTRY | DEVICE_OS | DMA | DEVICE_MAKE | DEMOGRAPHIC | REGION | INTEREST",
"action_report_time": "impression | conversion"
}
],
"account_sync_mode": "AllAccounts | SpecificAccounts",
"schema": "schema_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}Config parameters
| Name | Description |
|---|---|
sync_mode | Whether to sync all organizations or specific organizations. Default value: AllOrganizations. |
view_attribution_window | The time period to attribute conversions based on views. Default value: DAY_1 |
swipe_attribution_window | The time period to attribute conversions based on swipes. Default value: DAY_28 |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE. |
organizations | Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations. |
accounts | Specific accounts IDs to sync. Must be populated if accountSyncMode is set to SpecificAccounts. |
custom_reports | Custom reports for Snapchat Ads connector. |
custom_reports[0].sk_ad_metrics_fields | List of SKAd Metrics fields in custom report. |
custom_reports[0].add_metric_variants | Add fields for separate "swipe-up" and "view" variants of selected metrics |
custom_reports[0].base_metrics_fields | List of Core, Additional and Conversion Metrics Stats Fields. |
custom_reports[0].breakout | Sets Breakout on custom report. |
custom_reports[0].granularity | Sets Granularity on custom report. |
custom_reports[0].breakdown | Sets Breakdown on custom report. |
custom_reports[0].report_name | Custom report name (must be unique) |
custom_reports[0].dimension | Sets Dimension on custom report. |
custom_reports[0].action_report_time | Determines if reports will be based on imression on coversion time |
account_sync_mode | Whether to sync all accounts or specific accounts. Default value: AllAccounts. |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "snapchat_ads", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" } }Auth Parameters
Name Description refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.client_accessYour application client access fields. client_access.client_secretClient Secretof your Snapchat Ads client application.client_access.client_idClient IDof your Snapchat Ads client application.By using the Connect Card or the Fivetran dashboard.