API Configuration Options

If you configure your Facebook Ad Insights and Facebook Ads connectors using our REST API, you will need to provide specific values for some parameters.

See our REST API documentation for more information about using the Fivetran REST API to configure and .

fields

account_currency
account_id
account_name
action_values
actions
ad_id
ad_name
adset_id
adset_name
attribution_setting
buying_type
campaign_id
campaign_name
canvas_avg_view_percent
canvas_avg_view_time
catalog_segment_value
clicks
conversion_rate_ranking
conversion_values
conversions
cost_per_10_sec_video_view
cost_per_action_type
cost_per_conversion
cost_per_estimated_ad_recallers
cost_per_inline_link_click
cost_per_inline_post_engagement
cost_per_outbound_click
cost_per_thruplay
cost_per_unique_action_type
cost_per_unique_click
cost_per_unique_inline_link_click
cost_per_unique_outbound_click
cpc
cpm
cpp
ctr
engagement_rate_ranking
estimated_ad_recall_rate
estimated_ad_recallers
frequency
full_view_impressions
full_view_reach
gender_targeting
impressions
inline_link_click_ctr
inline_link_clicks
inline_post_engagement
instant_experience_clicks_to_open
instant_experience_clicks_to_start
instant_experience_outbound_clicks
labels
location
mobile_app_purchase_roas
objective
outbound_clicks
outbound_clicks_ctr
purchase_roas
quality_ranking
reach
relevance_score
social_spend
spend
unique_actions
unique_clicks
unique_ctr
unique_inline_link_click_ctr
unique_inline_link_clicks
unique_link_clicks_ctr
unique_outbound_clicks
unique_outbound_clicks_ctr
video_10_sec_watched_actions
video_30_sec_watched_actions
video_avg_percent_watched_actions
video_avg_time_watched_actions
video_p100_watched_actions
video_p25_watched_actions
video_p50_watched_actions
video_p75_watched_actions
video_p95_watched_actions
video_play_actions
video_play_curve_actions
video_thruplay_watched_actions
website_ctr
website_purchase_roas

breakdowns

ad_format_asset
age
app_id
body_asset
call_to_action_asset
country
description_asset
dma
gender
frequency_value
hourly_stats_aggregated_by_advertiser_time_zone
hourly_stats_aggregated_by_audience_time_zone
image_asset
impression_device
link_url_asset
place_page_id
device_platform
product_id
publisher_platform
platform_position
region
skan_conversion_id
title_asset
video_asset;

action_breakdowns

action_carousel_card_id
action_carousel_card_name
action_canvas_component_name
action_destination
action_device
action_reaction
action_target_id
action_type
action_video_sound
action_video_type;

sync_mode

AllAccounts
SpecificAccounts

aggregation

Day
Week
Month

config_type

Prebuilt
Custom

prebuilt_report

ACTION_CANVAS_COMPONENT
ACTION_CAROUSEL_CARD
ACTION_CONVERSION_DEVICE
ACTION_PRODUCT_ID
ACTION_REACTIONS
ACTION_VIDEO_SOUND
ACTION_VIDEO_VIEW_TYPE
BASIC_AD
BASIC_AD_SET
BASIC_ALL_LEVELS
BASIC_CAMPAIGN
DELIVERY_PLATFORM
DELIVERY_PLATFORM_AND_DEVICE
DELIVERY_PURCHASE_ROAS
DEMOGRAPHICS_AGE
DEMOGRAPHICS_AGE_AND_GENDER
DEMOGRAPHICS_COUNTRY
DEMOGRAPHICS_DMA_REGION
DEMOGRAPHICS_GENDER
DEMOGRAPHICS_REGION

action_report_time

impression
conversion
mixed

click_attribution_window

NONE
DAY_1
DAY_7

view_attribution_window

NONE
DAY_1
DAY_7