Facebook API Data Model

ad_id

string

☑

Ad ID.

account_currency

string

itgen_facebook_account_currency

☐

Currency that is used by your ad account.

account_id

string

itgen_facebook_account_id

☐

The ID number of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.

account_name

string

itgen_facebook_account_name

☐

The name of your ad account, which groups your advertising activity. Your ad account includes your campaigns, ads and billing.

action_values

string

itgen_facebook_action_values

☐

List of total values of all conversions attributed to your ads.

actions

string

Actions

☐

List of total numbers of actions people took that are attributed to your ads. Actions may include engagement, clicks or conversions.

ad_id

decimal

itgen_facebook_ad_id

☐

The unique ID of the ad you're viewing in reporting.

ad_name

string

itgen_facebook_ad_name

☐

The name of the ad you're viewing in reporting.

adset_id

decimal

itgen_facebook_adset_id

☐

The unique ID of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting.

adset_name

string

itgen_facebook_adset_name

☐

The name of the ad set you're viewing in reporting. An ad set is a group of ads that share the same budget, schedule, delivery optimization and targeting.

buying_type

string

itgen_facebook_buying_type

☐

The method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying. This field is currently only visible at the campaign level.

campaign_id

decimal

itgen_facebook_campaign_id

☐

The unique ID number of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.

campaign_name

string

itgen_facebook_campaign_name

☐

The name of the ad campaign you're viewing in reporting. Your campaign contains ad sets and ads.

canvas_avg_view_percent

decimal

itgen_facebook_canvas_avg_view_percent

☐

The average percentage of the Instant Experience that people saw. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.

canvas_avg_view_time

decimal

itgen_facebook_canvas_avg_view_time

☐

The average total time, in seconds, that people spent viewing an Instant Experience. An Instant Experience is a screen that opens after someone interacts with your ad on a mobile device. It may include a series of interactive or multimedia components, including video, images product catalog and more.

clicks

decimal

itgen_facebook_clicks

☐

The number of clicks on your ads.

cost_per_10_sec_video_view

string

itgen_facebook_cost_per_10_sec_video_view

☐

List of average costs for each 10-second video view.

cost_per_action_type

string

itgen_facebook_cost_per_action_type

☐

List of average costs of a relevant action.

cost_per_estimated_ad_recallers

decimal

itgen_facebook_cost_per_estimated_ad_recallers

☐

The average cost for each estimated ad recall lift. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

cost_per_inline_link_click

decimal

itgen_facebook_cost_per_inline_link_click

☐

The average cost of each inline link click.

cost_per_inline_post_engagement

decimal

itgen_facebook_cost_per_inline_post_engagement

☐

The average cost of each inline post engagement.

cost_per_outbound_click

string

itgen_facebook_cost_per_outbound_click

☐

List of average costs for each outbound click.

cost_per_thruplay

string

itgen_facebook_cost_per_thruplay

☐

List of average costs for each ThruPlay. This metric is in development.

cost_per_unique_action_type

string

itgen_facebook_cost_per_unique_action_type

☐

List of average costs of each unique action. This metric is estimated.

cost_per_unique_click

decimal

itgen_facebook_cost_per_unique_click

☐

The average cost for each unique click (all). This metric is estimated.

cost_per_unique_inline_link_click

decimal

itgen_facebook_cost_per_unique_inline_link_click

☐

The average cost of each unique inline link click. This metric is estimated.

cost_per_unique_outbound_click

string

itgen_facebook_cost_per_unique_outbound_click

☐

List of average costs for each unique outbound click. This metric is estimated.

cpc

decimal

itgen_facebook_cpc

☐

The average cost for each click (all).

cpm

decimal

itgen_facebook_cpm

☐

The average cost for 1,000 impressions.

cpp

decimal

itgen_facebook_cpp

☐

The average cost to reach 1,000 people. This metric is estimated.

ctr

decimal

itgen_facebook_ctr

☐

The percentage of times people saw your ad and performed a click (all).

date_start

string

itgen_facebook_date_start

☐

The start date for your data. This is controlled by the date range you've selected for your reporting view.

date_stop

string

itgen_facebook_date_stop

☐

The end date for your data. This is controlled by the date range you've selected for your reporting view.

estimated_ad_recall_rate

decimal

itgen_facebook_estimated_ad_recall_rate

☐

The rate at which an estimated number of additional people, when asked, would remember seeing your ads within 2 days. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

estimated_ad_recallers

decimal

itgen_facebook_estimated_ad_recallers

☐

An estimate of the number of additional people who may remember seeing your ads, if asked, within 2 days. This metric is only available for assets in the Brand awareness, Post engagement and Video views Objectives. This metric is estimated and in development.

frequency

decimal

itgen_facebook_frequency

☐

The average number of times each person saw your ad. This metric is estimated.

impressions

decimal

itgen_facebook_impressions

☐

The number of times your ads were on screen.

inline_link_click_ctr

decimal

itgen_facebook_inline_link_click_ctr

☐

The percentage of time people saw your ads and performed an inline link click.

inline_link_clicks

decimal

itgen_facebook_inline_link_clicks

☐

The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties. Inline link clicks use a fixed 1-day-click attribution window.

inline_post_engagement

decimal

itgen_facebook_inline_post_engagement

☐

The total number of actions that people take involving your ads. Inline post engagements use a fixed 1-day-click attribution window.

mobile_app_purchase_roas

string

itgen_facebook_mobile_app_purchase_roas

☐

List of total returns on ad spend (ROAS) from mobile app purchases. This is based on the value that you assigned when you set up the app event.

objective

string

itgen_facebook_objective

☐

The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.

outbound_clicks

string

itgen_facebook_outbound_clicks

☐

List of number of clicks on links that take people off Facebook-owned properties.

outbound_clicks_ctr

string

itgen_facebook_outbound_clicks_ctr

☐

List of percentage of times people saw your ad and performed an outbound click.

place_page_name

string

itgen_facebook_place_page_name

☐

The name of the place page involved in impression or click. Has to be used together with Business Locations breakdown.

reach

string

itgen_facebook_reach

☐

The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. This metric is estimated.

relevance_score_score

int32

itgen_facebook_relevance_score_score

☐

Score: 1-10, 10 being the highest.

relevance_score_status

string

itgen_facebook_relevance_score_status

☐

Status: OK, NOT_ENOUGH_IMPRESSIONS, UNKNOWN_ERROR.

spend

decimal

itgen_facebook_spend

☐

The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. This metric is estimated.

unique_actions

string

itgen_facebook_unique_actions

☐

List of number of people who took an action that was attributed to your ads. This metric is estimated.

unique_clicks

decimal

itgen_facebook_unique_clicks

☐

The number of people who performed a click (all). This metric is estimated.

unique_ctr

decimal

itgen_facebook_unique_ctr

☐

The percentage of people who saw your ad and performed a unique click (all). This metric is estimated.

unique_inline_link_click_ctr

decimal

itgen_facebook_unique_inline_link_click_ctr

☐

The percentage of times people saw your ad and performed a link click. Inline click-through rate uses a fixed 1-day-click attribution window. This metric is estimated.

unique_inline_link_clicks

decimal

itgen_facebook_unique_inline_link_clicks

☐

The number of people who performed an inline link click. This metric is estimated.

unique_link_clicks_ctr

decimal

itgen_facebook_unique_link_clicks_ctr

☐

The percentage of people who saw your ad and performed a link click. This metric is estimated.

unique_outbound_clicks

string

itgen_facebook_unique_outbound_clicks

☐

List of number of people who performed an outbound click. This metric is estimated.

unique_outbound_clicks_ctr

string

itgen_facebook_unique_outbound_clicks_ctr

☐

List of percentage of people who saw your ad and performed an outbound click. This metric is estimated.

video_10_sec_watched_actions

string

itgen_facebook_video_10_sec_watched_actions

☐

List of number of times your video played for at least 10 seconds, or for nearly its total length if it's shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.

video_30_sec_watched_actions

string

itgen_facebook_video_30_sec_watched_actions

☐

List of number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.

video_avg_percent_watched_actions

string

itgen_facebook_video_avg_percent_watched_actions

☐

List of average percentage of your video that people played.

video_avg_time_watched_actions

string

itgen_facebook_video_avg_time_watched_actions

☐

List of average time a video was played, including any time spent replaying the video for a single impression.

video_p100_watched_actions

string

itgen_facebook_video_p100_watched_actions

☐

List of number of times your video was played at 100% of its length, including plays that skipped to this point.

video_p25_watched_actions

string

itgen_facebook_video_p25_watched_actions

☐

List of number of times your video was played at 25% of its length, including plays that skipped to this point.

video_p50_watched_actions

string

itgen_facebook_video_p50_watched_actions

☐

List of number of times your video was played at 50% of its length, including plays that skipped to this point.

video_p75_watched_actions

string

itgen_facebook_video_p75_watched_actions

☐

List of number of times your video was played at 75% of its length, including plays that skipped to this point.

video_p95_watched_actions

string

itgen_facebook_video_p95_watched_actions

☐

List of number of times your video was played at 95% of its length, including plays that skipped to this point.

video_play_actions

string

itgen_facebook_video_play_actions

☐

List of number of times your video starts to play. This is counted for each impression of a video, and excludes replays. This metric is in development.

video_thruplay_watched_actions

string

itgen_facebook_video_thruplay_watched_actions

☐

List of number of times your video was played to completion, or for at least 15 seconds. Learn more. This metric is in development.

website_ctr

string

itgen_facebook_website_ctr

☐

List of percentage of times people saw your ad and performed a link click.

website_purchase_roas

string

itgen_facebook_website_purchase_roas

☐

List of total return on ad spend (ROAS) from website purchases. This is based on the value of all conversions recorded by the Facebook pixel on your website and attributed to your ads.