Custom Reports
Our Snapchat Ads connector supports custom reports that allow selecting the following parameters and fields:
- Breakdown
- Granularity
- Dimension (optional)
- Breakout (optional)
- Base metrics fields (optional)
- Additional fields corresponding to separate "swipe-up" and "view" variants of selected metrics (optional)
- SKAd metrics fields (optional)
NOTE: Some of these parameters have limitations described in the following sections.
Breakdown
This parameter supports the following values:
- CAMPAIGN
- AD
- AD_SQUAD
Granularity
This parameter supports the following values:
- HOUR - this value cannot be used together with the following parameters and fields selected for a custom report:
- any dimension
- any SKAd metric field
- any conversion event stats field
- any of the following additional metrics fields:
attachment_frequency
attachment_total_view_time_millis
attachment_uniques
frequency
uniques
total_reach
earned_reach
- DAY
Dimension
This parameter supports the following values:
- COUNTRY
- REGION
- DMA
- DEVICE_OS
- DEVICE_MAKE
- DEMOGRAPHIC
- INTEREST
Limitations
Dimensions won't work with any SKAd metric field selected for a custom report.
Dimensions won't work with any of the following additional metrics fields selected for a custom report:
avg_position_screen_time_millis
earned_impressions
earned_reach
native_leads
play_time_millis
position_impressions
position_screen_time_millis
position_swipe_up_percent
profile_clicks
total_reach
video_views_time_based
Breakout
This parameter supports the following values:
- total
- web
- app
- offline
- total_off_platform
- total_on_platform
Base metrics fields
Expand to see the full list of the supported fields.
We support the following base metrics fields:
impressions
swipes
view_time_millis
screen_time_millis
quartile_1
quartile_2
quartile_3
view_completion
spend
conversion_purchases
conversion_purchases_value
conversion_save
conversion_save_value
conversion_start_checkout
conversion_start_checkout_value
conversion_add_cart
conversion_add_cart_value
conversion_view_content
conversion_view_content_value
conversion_add_billing
conversion_add_billing_value
conversion_sign_ups
conversion_sign_ups_value
conversion_searches
conversion_searches_value
conversion_level_completes
conversion_level_completes_value
conversion_app_opens
conversion_app_opens_value
conversion_page_views
conversion_page_views_value
conversion_subscribe
conversion_subscribe_value
conversion_ad_click
conversion_ad_click_value
conversion_ad_view
conversion_ad_view_value
conversion_complete_tutorial
conversion_complete_tutorial_value
conversion_invite
conversion_invite_value
conversion_login
conversion_login_value
conversion_share
conversion_share_value
conversion_reserve
conversion_reserve_value
conversion_achievement_unlocked
conversion_achievement_unlocked_value
conversion_add_to_wishlist
conversion_add_to_wishlist_value
conversion_spend_credits
conversion_spend_credits_value
conversion_rate
conversion_rate_value
conversion_start_trial
conversion_start_trial_value
conversion_list_view
conversion_list_view_value
conversion_visit
conversion_visit_value
custom_event_1
custom_event_1_value
custom_event_2
custom_event_2_value
custom_event_3
custom_event_3_value
custom_event_4
custom_event_4_value
custom_event_5
custom_event_5_value
android_installs
attachment_avg_view_time_millis
attachment_frequency
attachment_quartile_1
attachment_quartile_2
attachment_quartile_3
attachment_total_view_time_millis
attachment_uniques
attachment_view_completion
attachment_video_views
avg_view_time_millis
avg_screen_time_millis
frequency
ios_installs
swipe_up_percent
total_installs
uniques
video_views_time_based
video_views_15s
story_opens
story_completes
profile_clicks
position_impressions
position_screen_time_millis
position_swipe_up_percent
avg_position_screen_time_millis
shares
saves
paid_impressions
earned_impressions
total_impressions
play_time_millis
total_reach
earned_reach
Swipe-up and view metric variants
You can choose to add the following additional fields to the report, corresponding to separate "swipe-up" and "view" variants of the selected metrics.
NOTE: The API field number limit per request is 50. Enabling this option adds two variant fields for each selected metric from the list below.
Expand to see the full list of the supported fields.
Metric | Swipe variant | View variant |
---|---|---|
total_installs | total_installs_swipe_up | total_installs_view |
android_installs | android_installs_swipe_up | android_installs_view |
ios_installs | ios_installs_swipe_up | ios_installs_view |
conversion_purchases | conversion_purchases_swipe_up | conversion_purchases_view |
conversion_purchases_value | conversion_purchases_value_swipe_up | conversion_purchases_value_view |
conversion_save | conversion_save_swipe_up | conversion_save_view |
conversion_start_checkout | conversion_start_checkout_swipe_up | conversion_start_checkout_view |
conversion_add_cart | conversion_add_cart_swipe_up | conversion_add_cart_view |
conversion_view_content | conversion_view_content_swipe_up | conversion_view_content_view |
conversion_add_billing | conversion_add_billing_swipe_up | conversion_add_billing_view |
conversion_sign_ups | conversion_sign_ups_swipe_up | conversion_sign_ups_view |
conversion_searches | conversion_searches_swipe_up | conversion_searches_view |
conversion_level_completes | conversion_level_completes_swipe_up | conversion_level_completes_view |
conversion_app_opens | conversion_app_opens_swipe_up | conversion_app_opens_view |
conversion_page_views | conversion_page_views_swipe_up | conversion_page_views_view |
conversion_subscribe | conversion_subscribe_swipe_up | conversion_subscribe_view |
conversion_ad_click | conversion_ad_click_swipe_up | conversion_ad_click_view |
conversion_ad_view | conversion_ad_view_swipe_up | conversion_ad_view_view |
conversion_complete_tutorial | conversion_complete_tutorial_swipe_up | conversion_complete_tutorial_view |
conversion_invite | conversion_invite_swipe_up | conversion_invite_view |
conversion_login | conversion_login_swipe_up | conversion_login_view |
conversion_share | conversion_share_swipe_up | conversion_share_view |
conversion_reserve | conversion_reserve_swipe_up | conversion_reserve_view |
conversion_achievement_unlocked | conversion_achievement_unlocked_swipe_up | conversion_achievement_unlocked_view |
conversion_add_to_wishlist | conversion_add_to_wishlist_swipe_up | conversion_add_to_wishlist_view |
conversion_spend_credits | conversion_spend_credits_swipe_up | conversion_spend_credits_view |
conversion_rate | conversion_rate_swipe_up | conversion_rate_view |
conversion_start_trial | conversion_start_trial_swipe_up | conversion_start_trial_view |
conversion_list_view | conversion_list_view_swipe_up | conversion_list_view_view |
custom_event_1 | custom_event_1_swipe_up | custom_event_1_view |
custom_event_2 | custom_event_2_swipe_up | custom_event_2_view |
custom_event_3 | custom_event_3_swipe_up | custom_event_3_view |
custom_event_4 | custom_event_4_swipe_up | custom_event_4_view |
custom_event_5 | custom_event_5_swipe_up | custom_event_5_view |
SKAd metrics fields
Expand to see the full list of the supported fields.
We support the following SKAd metrics fields:
conversion_total_installs_sk_ad_network_total
conversion_ios_installs_sk_ad_network_total
conversion_purchases_sk_ad_network_total
conversion_save_sk_ad_network_total
conversion_start_checkout_sk_ad_network_total
conversion_add_cart_sk_ad_network_total
conversion_view_content_sk_ad_network_total
conversion_add_billing_sk_ad_network_total
conversion_sign_ups_sk_ad_network_total
conversion_searches_sk_ad_network_total
conversion_level_completes_sk_ad_network_total
conversion_app_opens_sk_ad_network_total
conversion_page_views_sk_ad_network_total
conversion_subscribe_sk_ad_network_total
conversion_ad_click_sk_ad_network_total
conversion_ad_view_sk_ad_network_total
conversion_complete_tutorial_sk_ad_network_total
conversion_invite_sk_ad_network_total
conversion_login_sk_ad_network_total
conversion_share_sk_ad_network_total
conversion_reserve_sk_ad_network_total
conversion_achievement_unlocked_sk_ad_network_total
conversion_add_to_wishlist_sk_ad_network_total
conversion_spend_credits_sk_ad_network_total
conversion_rate_sk_ad_network_total
conversion_start_trial_sk_ad_network_total
conversion_list_view_sk_ad_network_total
custom_event_1_sk_ad_network_total
custom_event_2_sk_ad_network_total
custom_event_3_sk_ad_network_total
custom_event_4_sk_ad_network_total
custom_event_5_sk_ad_network_total
unknown_sk_ad_network_total
conversion_assist_install_sk_ad_network_total
conversion_total_installs_sk_ad_network
conversion_ios_installs_sk_ad_network
conversion_purchases_sk_ad_network
conversion_save_sk_ad_network
conversion_start_checkout_sk_ad_network
conversion_add_cart_sk_ad_network
conversion_view_content_sk_ad_network
conversion_add_billing_sk_ad_network
conversion_sign_ups_sk_ad_network
conversion_searches_sk_ad_network
conversion_level_completes_sk_ad_network
conversion_app_opens_sk_ad_network
conversion_page_views_sk_ad_network
conversion_subscribe_sk_ad_network
conversion_ad_click_sk_ad_network
conversion_ad_view_sk_ad_network
conversion_complete_tutorial_sk_ad_network
conversion_invite_sk_ad_network
conversion_login_sk_ad_network
conversion_share_sk_ad_network
conversion_reserve_sk_ad_network
conversion_achievement_unlocked_sk_ad_network
conversion_add_to_wishlist_sk_ad_network
conversion_spend_credits_sk_ad_network
conversion_rate_sk_ad_network
conversion_start_trial_sk_ad_network
conversion_list_view_sk_ad_network
custom_event_1_sk_ad_network
custom_event_2_sk_ad_network
custom_event_3_sk_ad_network
custom_event_4_sk_ad_network
custom_event_5_sk_ad_network
unknown_sk_ad_network
conversion_assist_install_sk_ad_network
conversion_total_installs_sk_ad_network_view
conversion_ios_installs_sk_ad_network_view
conversion_purchases_sk_ad_network_view
conversion_save_sk_ad_network_view
conversion_start_checkout_sk_ad_network_view
conversion_add_cart_sk_ad_network_view
conversion_view_content_sk_ad_network_view
conversion_add_billing_sk_ad_network_view
conversion_sign_ups_sk_ad_network_view
conversion_searches_sk_ad_network_view
conversion_level_completes_sk_ad_network_view
conversion_app_opens_sk_ad_network_view
conversion_page_views_sk_ad_network_view
conversion_subscribe_sk_ad_network_view
conversion_ad_click_sk_ad_network_view
conversion_ad_view_sk_ad_network_view
conversion_complete_tutorial_sk_ad_network_view
conversion_invite_sk_ad_network_view
conversion_login_sk_ad_network_view
conversion_share_sk_ad_network_view
conversion_reserve_sk_ad_network_view
conversion_achievement_unlocked_sk_ad_network_view
conversion_add_to_wishlist_sk_ad_network_view
conversion_spend_credits_sk_ad_network_view
conversion_rate_sk_ad_network_view
conversion_start_trial_sk_ad_network_view
conversion_list_view_sk_ad_network_view
custom_event_1_sk_ad_network_view
custom_event_2_sk_ad_network_view
custom_event_3_sk_ad_network_view
custom_event_4_sk_ad_network_view
custom_event_5_sk_ad_network_view
unknown_sk_ad_network_view
conversion_assist_install_sk_ad_network_view
conversion_null_sk_ad_network_view