Facebook

The Facebook pipelines created by Kondado allows you to have access to your posts, campaigns and ads data in your analytical cloud.

Adding the data source

To automate Facebook ETL with Kondado for your database, follow the steps below:

1) On the Kondado platform, go to the add new sources page and select the Facebook data source;

2) Name your data source and click “Continue with Facebook”:

ATTENTION: In addition to pop-up blockers, some antiviruses can also prevent the “Continue with Facebook” button from being displayed. So, if you are already using the chrome browser and with an incognito window and the button is still not appearing, disable your antivirus for a few moments and reload the page for the button to appear. Reactivate your antivirus after finishing the process

3) You will now be directed to a Facebook login page, where you must enter your credentials

4) After logging in with your Facebook account linked to your Facebook Ads account, you will need to give permission to Kondado by clicking “Continue”

5) In the next step you must select the account you wish to use and click on “Next”

6) On the permissions page, leave all options marked with “Yes” and click on “Finish”

Now you can save your data source and start replicating your Facebook Ads data into the Data Lake or Data Warehouse.

In the pipelines listed below, you can better check the permissions and access levels on facebook that the account that added the Kondado data source must have

Pipelines

Summary

Relationship Chart

Ad performance

Main object

Campo Tipo

account_id

text

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

    Contas de anúncio > > account_id

metric_date

date

[en] The date to which this row refers to (calculated by Kondado)

account_name

text

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

adset_id

text

[en] 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

campaign_id

text

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

frequency

float

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

estimated_ad_recallers

float

[en] The estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

estimated_ad_recall_rate

float

[en] The rate that an estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

cost_per_estimated_ad_recallers

float

[en] The estimated cost for each additional person that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

inline_link_clicks

float

[en] 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

unique_inline_link_clicks

float

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

impressions

float

[en] The number of times your ads were on screen

campaign_name

text

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

unique_clicks

float

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

adset_name

text

[en] 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

objective

text

[en] The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases

clicks

float

[en] The number of clicks on your ads

ad_id

text

[en] The unique ID of the ad you're viewing in reporting

    Detalhes dos anúncios > > ad_id

reach

float

[en] 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

ad_name

text

[en] The name of the ad you're viewing in reporting

account_currency

text

[en] Currency that is used by your ad account

inline_post_engagement

float

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

spend

float

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

ctr

float

[en] The percentage of times people saw your ad and performed a click (all)

cpp

float

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

cpm

float

[en] The average cost for 1,000 impressions

cpc

float

[en] The average cost for each click (all)

optimization_goal

text

[en] What the ad set is optimizing for - APP_INSTALLS: Will optimize for people more likely to install your app; ENGAGED_USERS: Will optimize for people more likely to take a particular action in your app; EVENT_RESPONSES: Will optimize for people more likely to attend your event; IMPRESSIONS: Will show the ads as many times as possible; LEAD_GENERATION: Will optimize for people more likely to fill out a lead generation form; LINK_CLICKS: Will optimize for people more likely to click in the link of the ad; OFFER_CLAIMS: Will optimize for people more likely to claim the offer; OFFSITE_CONVERSIONS: Will optimize for people more likely to make a conversion in the site; PAGE_ENGAGEMENT: Will optimize for people more likely to engage with your page; PAGE_LIKES: Will optimize for people more likely to like your page; POST_ENGAGEMENT: Will optimize for people more likely to engage with your post; REACH: Optimize to reach the most unique users of each day or interval specified in frequency_control_specs; SOCIAL_IMPRESSIONS: Increase the number of impressions with social context. For example, with the names of one or more of the user's friends attached to the ad who have already liked the page or installed the app; VALUE: Will optimize for maximum total purchase value within the specified attribution window; THRUPLAY: Will optimize delivery of your ads to people are more likely to play your ad to completion, or play it for at least 15 seconds; AD_RECALL_LIFT: Optimize for people more likely to remember seeing your ads; VISIT_INSTAGRAM_PROFILE: Optimize for visits to the advertiser's instagram profile

facebook_ad_insights__actions

Campo Tipo

metric_date

date

account_id

text

account_name

text

adset_id

text

campaign_id

text

campaign_name

text

adset_name

text

ad_id

text

ad_name

text

actions__value

float

actions_1d_view

float

actions_7d_view

float

actions_28d_view

float

actions_1d_click

float

actions_7d_click

float

actions_28d_click

float

actions__action_type

text

facebook_ad_insights_action_values

Campo Tipo

metric_date

date

account_id

text

account_name

text

adset_id

text

campaign_id

text

campaign_name

text

adset_name

text

ad_id

text

ad_name

text

action_values_value

float

action_values_1d_view

float

action_values_7d_view

float

action_values_28d_view

float

action_values_1d_click

float

action_values_7d_click

float

action_values_28d_click

float

action_values_action_type

text

To make the best use of this pipeline, understand more about actions, breakdown, period and update window

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Due to Facebook API limitations, this pipeline brings a maximum period of 37 months (1110 days) into the past

Ad set performance

Main object

Campo Tipo

account_id

text

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

    Contas de anúncio > > account_id

metric_date

date

[en] The date to which this row refers to (calculated by Kondado)

account_name

text

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

adset_id

text

[en] 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

campaign_id

text

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

frequency

float

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

estimated_ad_recallers

float

[en] The estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

estimated_ad_recall_rate

float

[en] The rate that an estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

cost_per_estimated_ad_recallers

float

[en] The estimated cost for each additional person that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

inline_link_clicks

float

[en] 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

unique_inline_link_clicks

float

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

impressions

float

[en] The number of times your ads were on screen

campaign_name

text

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

unique_clicks

float

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

adset_name

text

[en] 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

objective

text

[en] The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases

clicks

float

[en] The number of clicks on your ads

reach

float

[en] 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

account_currency

text

[en] Currency that is used by your ad account

inline_post_engagement

float

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

spend

float

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

ctr

float

[en] The percentage of times people saw your ad and performed a click (all)

cpp

float

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

cpm

float

[en] The average cost for 1,000 impressions

cpc

float

[en] The average cost for each click (all)

optimization_goal

text

[en] What the ad set is optimizing for - APP_INSTALLS: Will optimize for people more likely to install your app; ENGAGED_USERS: Will optimize for people more likely to take a particular action in your app; EVENT_RESPONSES: Will optimize for people more likely to attend your event; IMPRESSIONS: Will show the ads as many times as possible; LEAD_GENERATION: Will optimize for people more likely to fill out a lead generation form; LINK_CLICKS: Will optimize for people more likely to click in the link of the ad; OFFER_CLAIMS: Will optimize for people more likely to claim the offer; OFFSITE_CONVERSIONS: Will optimize for people more likely to make a conversion in the site; PAGE_ENGAGEMENT: Will optimize for people more likely to engage with your page; PAGE_LIKES: Will optimize for people more likely to like your page; POST_ENGAGEMENT: Will optimize for people more likely to engage with your post; REACH: Optimize to reach the most unique users of each day or interval specified in frequency_control_specs; SOCIAL_IMPRESSIONS: Increase the number of impressions with social context. For example, with the names of one or more of the user's friends attached to the ad who have already liked the page or installed the app; VALUE: Will optimize for maximum total purchase value within the specified attribution window; THRUPLAY: Will optimize delivery of your ads to people are more likely to play your ad to completion, or play it for at least 15 seconds; AD_RECALL_LIFT: Optimize for people more likely to remember seeing your ads; VISIT_INSTAGRAM_PROFILE: Optimize for visits to the advertiser's instagram profile

facebook_adset_insights__actions

Campo Tipo

account_name

text

account_id

text

adset_id

text

campaign_id

text

campaign_name

text

adset_name

text

metric_date

date

actions__value

float

actions_1d_view

float

actions_7d_view

float

actions_28d_view

float

actions_1d_click

float

actions_7d_click

float

actions_28d_click

float

actions__action_type

text

facebook_adset_insights_action_values

Campo Tipo

account_name

text

account_id

text

adset_id

text

campaign_id

text

campaign_name

text

adset_name

text

metric_date

date

action_values_value

float

action_values_1d_view

float

action_values_7d_view

float

action_values_28d_view

float

action_values_1d_click

float

action_values_7d_click

float

action_values_28d_click

float

action_values_action_type

text

To make the best use of this pipeline, understand more about actions, breakdown, period and update window

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Due to Facebook API limitations, this pipeline brings a maximum period of 37 months (1110 days) into the past

Campaign performance

Main object

Campo Tipo

account_id

text

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

    Contas de anúncio > > account_id

metric_date

date

[en] The date to which this row refers to (calculated by Kondado)

account_name

text

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

campaign_id

text

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

frequency

float

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

estimated_ad_recallers

float

[en] The estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

estimated_ad_recall_rate

float

[en] The rate that an estimated number of additional people that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

cost_per_estimated_ad_recallers

float

[en] The estimated cost for each additional person that would remember seeing your ads within 2 days if asked - only available for assets with Brand Awareness objective

inline_link_clicks

float

[en] 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

unique_inline_link_clicks

float

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

impressions

float

[en] The number of times your ads were on screen

campaign_name

text

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

unique_clicks

float

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

objective

text

[en] The objective reflecting the goal you want to achieve with your advertising. It may be different from the selected objective of the campaign in some cases

clicks

float

[en] The number of clicks on your ads

reach

float

[en] 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

account_currency

text

[en] Currency that is used by your ad account

inline_post_engagement

float

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

spend

float

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

ctr

float

[en] The percentage of times people saw your ad and performed a click (all)

cpp

float

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

cpm

float

[en] The average cost for 1,000 impressions

cpc

float

[en] The average cost for each click (all)

optimization_goal

text

[en] What the ad set is optimizing for - APP_INSTALLS: Will optimize for people more likely to install your app; ENGAGED_USERS: Will optimize for people more likely to take a particular action in your app; EVENT_RESPONSES: Will optimize for people more likely to attend your event; IMPRESSIONS: Will show the ads as many times as possible; LEAD_GENERATION: Will optimize for people more likely to fill out a lead generation form; LINK_CLICKS: Will optimize for people more likely to click in the link of the ad; OFFER_CLAIMS: Will optimize for people more likely to claim the offer; OFFSITE_CONVERSIONS: Will optimize for people more likely to make a conversion in the site; PAGE_ENGAGEMENT: Will optimize for people more likely to engage with your page; PAGE_LIKES: Will optimize for people more likely to like your page; POST_ENGAGEMENT: Will optimize for people more likely to engage with your post; REACH: Optimize to reach the most unique users of each day or interval specified in frequency_control_specs; SOCIAL_IMPRESSIONS: Increase the number of impressions with social context. For example, with the names of one or more of the user's friends attached to the ad who have already liked the page or installed the app; VALUE: Will optimize for maximum total purchase value within the specified attribution window; THRUPLAY: Will optimize delivery of your ads to people are more likely to play your ad to completion, or play it for at least 15 seconds; AD_RECALL_LIFT: Optimize for people more likely to remember seeing your ads; VISIT_INSTAGRAM_PROFILE: Optimize for visits to the advertiser's instagram profile

facebook_campaign_insights__actions

Campo Tipo

account_name

text

account_id

text

campaign_id

text

campaign_name

text

metric_date

date

actions__value

float

actions_1d_view

float

actions_7d_view

float

actions_28d_view

float

actions_1d_click

float

actions_7d_click

float

actions_28d_click

float

actions__action_type

text

facebook_campaign_insights_action_values

Campo Tipo

account_name

text

account_id

text

campaign_id

text

campaign_name

text

metric_date

date

action_values_value

float

action_values_1d_view

float

action_values_7d_view

float

action_values_28d_view

float

action_values_1d_click

float

action_values_7d_click

float

action_values_28d_click

float

action_values_action_type

text

To make the best use of this pipeline, understand more about actions, breakdown, period and update window

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Due to Facebook API limitations, this pipeline brings a maximum period of 37 months (1110 days) into the past

Leads

Main Object

Field Type

id

text

[en] ID of the lead

ad_id

text

[en] Ad ID for the Lead Ad

    Detalhes dos anúncios > > ad_id

ad_name

text

[en] Ad name for the Lead Ad

adset_id

text

[en] Ad Set ID for the Lead Ad

adset_name

text

[en] Ad Set name for the Lead Ad

campaign_id

text

[en] Campaign ID for the Lead Ad

campaign_name

text

[en] Campaign name for the Lead Ad

created_time

timestamp

[en] Time this object was created

form_id

text

[en] Form ID used for the Lead Ads

is_organic

boolean

[en] Indicates whether the lead is organic

platform

text

[en] The platform attributed to the Lead

facebook_leads__field_data

Field Type

lead_id

text

[en] ID of the lead (inhrerited from main object)

field_data_name

text

[en] Name of the field of the form data submitted by the user

field_data_values

text

[en] Value of the field of the form data submitted by the user

Attention: for this pipeline to work correctly, the account used to create the data source in Kondado must be a page administrator and have permission to access leads. Find out more by clicking here and here
Permission to manage leads is granted by default to all page admins, but may have changed from this default. By accessing business.facebook.com > Settings (bottom left) > Business Settings > Pipelines > Lead Access – if you find a page similar to the image below, then access is granted to all page admins (default):

fb_lead_access.png

However, if the page is similar to this other image below, it will be necessary to include the facebook user who authenticated the Kondado data source in the list using the button indicated in the image:

fb_lead_access_granular_grant.png

 

Due to Facebook API limitations, this pipeline brings a maximum period of 37 months (1110 days) into the past

Ad Details

Field Type

ad_id

text

[en] The ID of the ad

account_id

text

[en] The ID of the Ad Account

    Contas de anúncio > > account_id

adset_id

text

[en] ID of the ad set that contains the ad

adset_name

text

[en] Name of the ad set that contains this ad

campaign_id

text

[en] ID of the ad campaign that contains this ad

campaign_name

text

[en] Name of the ad campaign that contains this ad

created_time

timestamp

[en] Time when the ad was created

name

text

[en] Name of the ad

source_ad_id

text

[en] The source ad id that this ad is copied from (zero if not a copy)

    Detalhes dos anúncios > > ad_id

status

text

[en] The configured status of the ad

updated_time

timestamp

[en] Time when this ad was updated

creative_actor_id

text

[en] The actor ID (Page ID) of this creative

    Páginas > > id

creative_body

text

[en] The body of the ad. Not supported for video post creatives

creative_call_to_action_type

text

[en] Type of call to action button in your ad. This determines the button text and header text for your ad

creative_id

text

[en] Unique ID for an ad creative

creative_name

text

[en] Name of this ad creative as seen in the ad account's library

creative_object_type

text

[en] The type of Facebook object you want to advertise. Allowed values are: PAGE, DOMAIN, EVENT, STORE_ITEM (refers to an iTunes or Google Play store destination), SHARE (from a page), PHOTO, STATUS (of a page), VIDEO, APPLICATION (app on Facebook), INVALID (when an invalid object_id was specified such as a deleted object or if we do not have permission to see the object. In very few cases, this field may be empty if Facebook is unable to identify the type of advertised object), PRIVACY_CHECK_FAIL (we are missing the permission to load this object type), POST_DELETED (this object_type has been deleted)

creative_thumbnail_url

text

[en] URL for a thumbnail image for this ad creative

creative_image_url

text

[en] A URL for the image for this creative. We save the image at this URL to the ad account's image library

creative_title

text

[en] Title for link ad, which does not belong to a page

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Ad Preview

Field Type

ad_id

text

[en] The unique ID of the ad you're viewing in reporting

    Detalhes dos anúncios > > ad_id

body

text

[en] Iframe HTML with ad preview

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Due to Facebook API limitations, this pipeline brings a maximum period of 37 months (1110 days) into the past

Ad Accounts

Field Type

id

text

[en] The string act_{ad_account_id}.

account_id

text

[en] The ID of the Ad Account

account_status

float

[en] Status of the account: 1 = ACTIVE, 2 = DISABLED, 3 = UNSETTLED, 7 = PENDING_RISK_REVIEW, 8 = PENDING_SETTLEMENT, 9 = IN_GRACE_PERIOD, 100 = PENDING_CLOSURE, 101 = CLOSED, 201 = ANY_ACTIVE, 202 = ANY_CLOSED

age

float

[en] Amount of time the ad account has been open, in days.

amount_spent

float

[en] Current total amount spent by the account. This can be reset

balance

float

[en] Bill amount due for this Ad Account.

business_city

text

[en] City for business address

business_country_code

text

[en] Country code for the business address

business_name

text

[en] The business name for the account

business_state

text

[en] State abbreviation for business address

business_street

text

[en] First line of the business street address for the account

business_street2

text

[en] Second line of the business street address for the account

business_zip

text

[en] Zip code for business address

can_create_brand_lift_study

boolean

[en] If we can create a new automated brand lift study under the Ad Account

created_time

text

[en] The time the account was created in ISO 8601 format

currency

text

[en] The currency used for the account, based on the corresponding value in the account settings

disable_reason

float

[en] The reason why the account was disabled. Possible reasons are: 0 = NONE, 1 = ADS_INTEGRITY_POLICY, 2 = ADS_IP_REVIEW, 3 = RISK_PAYMENT, 4 = GRAY_ACCOUNT_SHUT_DOWN, 5 = ADS_AFC_REVIEW, 6 = BUSINESS_INTEGRITY_RAR, 7 = PERMANENT_CLOSE, 8 = UNUSED_RESELLER_ACCOUNT, 9 = UNUSED_ACCOUNT, 10 = UMBRELLA_AD_ACCOUNT, 11 = BUSINESS_MANAGER_INTEGRITY_POLICY, 12 = MISREPRESENTED_AD_ACCOUNT, 13 = AOAB_DESHARE_LEGAL_ENTITY, 14 = CTX_THREAD_REVIEW, 15 = COMPROMISED_AD_ACCOUNT

end_advertiser

text

[en] The entity the ads will target. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID

end_advertiser_name

text

[en] The name of the entity the ads will target

min_daily_budget

float

[en] The minimum daily budget for this Ad Account

name

text

[en] Name of the account. If not set, the name of the first admin visible to the user will be returned

spend_cap

float

[en] The maximum amount that can be spent by this Ad Account. When the amount is reached, related Ad Campaigns are paused. A value of 0 means no spending-cap. Setting a new spend cap only applies to spend AFTER the time at which you set it. Value specified in basic unit of the currency, for example 'cents' for USD

tax_id

text

[en] Tax ID

timezone_name

text

[en] Name for the time zone

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Pages

This pipeline is in beta mode. Let us know if you find any unexpected results.

Main Object

Field Type

id

text

[en] The ID representing a Facebook Page

category

text

[en] The Page's category. e.g. Product/Service, Computers/Technology

tasks

text

[en] tasks on the page, such as ADVERTISE

name

text

[en] The name of the Page

about

text

[en] Information about the Page. This value maps to the Description setting in the Edit Page Info user interface

affiliation

text

[en] Affiliation of this person. Applicable to Pages representing people

artists_we_like

text

[en] Artists the band likes. Applicable to Bands

attire

text

[en] Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified

awards

text

[en] The awards information of the film. Applicable to Films

band_interests

text

[en] Band interests. Applicable to Bands

band_members

text

[en] Members of the band. Applicable to Bands

bio

text

[en] Biography of the band. Applicable to Bands

birthday

date

[en] Birthday of this person. Applicable to Pages representing people

booking_agent

text

[en] Booking agent of the band. Applicable to Bands

built

text

[en] Year vehicle was built. Applicable to Vehicles

can_checkin

boolean

[en] Whether the Page has checkin functionality enabled

checkins

float

[en] Number of checkins at a place represented by a Page

country_page_likes

float

[en] If this is a Page in a Global Pages hierarchy, the number of people who are being directed to this Page

culinary_team

text

[en] Culinary team of the business. Applicable to Restaurants or Nightlife

current_location

text

[en] Current location of the Page

description

text

[en] The description of the Page. Note that this value is mapped to the Additional Information setting in the Edit Page Info user interface

directed_by

text

[en] The director of the film. Applicable to Films

display_subtext

text

[en] Subtext about the Page being viewed

displayed_message_response_time

text

[en] Page estimated message response time displayed to user

emails

text

[en] The emails listed in the About section of a Page

fan_count

float

[en] The number of users who like the Page. For Global Pages this is the count for all Pages across the brand. For New Page Experience Pages, this field will return followers_count

features

text

[en] Features of the vehicle. Applicable to Vehicles

followers_count

float

[en] Number of page followers

food_styles

text

[en] The restaurant's food styles. Applicable to Restaurants

founded

int

[en] When the company was founded. Applicable to Pages in the Company category

general_info

text

[en] General information provided by the Page

general_manager

text

[en] General manager of the business. Applicable to Restaurants or Nightlife

genre

text

[en] The genre of the film. Applicable to Films

global_brand_page_name

text

[en] The name of the Page with country codes appended for Global Pages

global_brand_root_id

text

[en] This brand's global Root ID

has_transitioned_to_new_page_experience

boolean

[en] indicates whether a page has transitioned to new page experience or not

has_whatsapp_business_number

boolean

[en] Indicates whether WhatsApp number connected to this page is a WhatsApp business number

has_whatsapp_number

boolean

[en] Indicates whether WhatsApp number connected to this page is a WhatsApp number

hometown

text

[en] Hometown of the band. Applicable to Bands

hours_mon_1_open

text

[en] Time the business opens on Monday (first range). If always open, see is_always_open

hours_mon_1_close

text

[en] Time the business closes on Monday (first range). If always open, see is_always_open

hours_mon_2_open

text

[en] Time the business opens on Monday (second range). If always open, see is_always_open

hours_mon_2_close

text

[en] Time the business closes on Monday (second range). If always open, see is_always_open

hours_tue_1_open

text

[en] Time the business opens on Tuesday (first range). If always open, see is_always_open

hours_tue_1_close

text

[en] Time the business closes on Tuesday (first range). If always open, see is_always_open

hours_tue_2_open

text

[en] Time the business opens on Tuesday (second range). If always open, see is_always_open

hours_tue_2_close

text

[en] Time the business closes on Tuesday (second range). If always open, see is_always_open

hours_wed_1_open

text

[en] Time the business opens on Wednesday (first range). If always open, see is_always_open

hours_wed_1_close

text

[en] Time the business closes on Wednesday (first range). If always open, see is_always_open

hours_wed_2_open

text

[en] Time the business opens on Wednesday (second range). If always open, see is_always_open

hours_wed_2_close

text

[en] Time the business closes on Wednesday (second range). If always open, see is_always_open

hours_thu_1_open

text

[en] Time the business opens on Thursday (first range). If always open, see is_always_open

hours_thu_1_close

text

[en] Time the business closes on Thursday (first range). If always open, see is_always_open

hours_thu_2_open

text

[en] Time the business opens on Thursday (second range). If always open, see is_always_open

hours_thu_2_close

text

[en] Time the business closes on Thursday (second range). If always open, see is_always_open

hours_fri_1_open

text

[en] Time the business opens on Friday (first range). If always open, see is_always_open

hours_fri_1_close

text

[en] Time the business closes on Friday (first range). If always open, see is_always_open

hours_fri_2_open

text

[en] Time the business opens on Friday (second range). If always open, see is_always_open

hours_fri_2_close

text

[en] Time the business closes on Friday (second range). If always open, see is_always_open

hours_sat_1_open

text

[en] Time the business opens on Saturday (first range). If always open, see is_always_open

hours_sat_1_close

text

[en] Time the business closes on Saturday (first range). If always open, see is_always_open

hours_sat_2_open

text

[en] Time the business opens on Saturday (second range). If always open, see is_always_open

hours_sat_2_close

text

[en] Time the business closes on Saturday (second range). If always open, see is_always_open

hours_sun_1_open

text

[en] Time the business opens on Sunday (first range). If always open, see is_always_open

hours_sun_1_close

text

[en] Time the business closes on Sunday (first range). If always open, see is_always_open

hours_sun_2_open

text

[en] Time the business opens on Sunday (second range). If always open, see is_always_open

hours_sun_2_close

text

[en] Time the business closes on Sunday (second range). If always open, see is_always_open

impressum

text

[en] Legal information about the Page publishers

influences

text

[en] Influences on the band. Applicable to Bands

is_always_open

boolean

[en] Indicates whether this location is always open

is_chain

boolean

[en] Indicates whether location is part of a chain

is_community_page

boolean

[en] Indicates whether the Page is a community Page

is_eligible_for_branded_content

boolean

[en] Indicates whether the page is eligible for the branded content tool

is_messenger_bot_get_started_enabled

boolean

[en] Indicates whether the page is a Messenger Platform Bot with Get Started button enabled

is_messenger_platform_bot

boolean

[en] Indicates whether the page is a Messenger Platform Bot

is_owned

boolean

[en] Indicates whether Page is owned

is_permanently_closed

boolean

[en] Whether the business corresponding to this Page is permanently closed

is_published

boolean

[en] Indicates whether the Page is published and visible to non-admins

is_unclaimed

boolean

[en] Indicates whether the Page is unclaimed

link

text

[en] The Page's Facebook URL

members

text

[en] Members of this org. Applicable to Pages representing Team Orgs

messenger_ads_default_icebreakers

text

[en] The default ice breakers for a certain page

messenger_ads_default_quick_replies

text

[en] The default quick replies for a certain page

messenger_ads_quick_replies_type

text

[en] Indicates what type this page is and we will generate different sets of quick replies based on it. Values include UNKNOWN, PAGE_SHOP, or RETAIL

mission

text

[en] The company mission. Applicable to Companies

mpg

text

[en] MPG of the vehicle. Applicable to Vehicles

network

text

[en] The TV network for the TV show. Applicable to TV Shows

overall_star_rating

float

[en] Overall page rating based on rating survey from users on a scale of 1-5. This value is normalized and is not guaranteed to be a strict average of user ratings. If there are 0 or a small number of ratings, this field will not be returned

personal_info

text

[en] Personal information. Applicable to Pages representing People

personal_interests

text

[en] Personal interests. Applicable to Pages representing People

pharma_safety_info

text

[en] Pharmacy safety information. Applicable to Pharmaceutical companies

phone

text

[en] Pharmacy safety information. Applicable to Pharmaceutical companies

pickup_options

text

[en] List of pickup options available at this Page's store location. Values can include CURBSIDE, IN_STORE, and OTHER

place_type

text

[en] For places, the category of the place. Value can be CITY, COUNTRY, EVENT, GEO_ENTITY, PLACE, RESIDENCE, STATE_PROVINCE, or TEXT

plot_outline

text

[en] The plot outline of the film. Applicable to Films

press_contact

text

[en] Press contact information of the band. Applicable to Bands

price_range

text

[en] Price range of the business, such as a restaurant or salon. Values can be one of $, $$, $$$, $$$$, Not Applicable, or null if no value is set

privacy_info_url

text

[en] Privacy url in page info section

produced_by

text

[en] The productor of the film. Applicable to Films

products

text

[en] The products of this company. Applicable to Companies

public_transit

text

[en] Public transit to the business. Applicable to Restaurants or Nightlife

rating_count

int

[en] Number of ratings for the Page (limited to ratings that are publicly accessible)

record_label

text

[en] Record label of the band. Applicable to Bands

release_date

text

[en] The film's release date. Applicable to Films

schedule

text

[en] The air schedule of the TV show. Applicable to TV Shows

screenplay_by

text

[en] The screenwriter of the film. Applicable to Films

season

text

[en] The season information of the TV Show. Applicable to TV Shows

single_line_address

text

[en] The Page address, if any, in a simple single line format

starring

text

[en] The cast of the film. Applicable to Films

store_code

text

[en] Unique store code for this location Page

store_location_descriptor

text

[en] Location Page's store location descriptor

store_number

text

[en] Unique store number for this location Page

studio

text

[en] The studio for the film production. Applicable to Films

supports_donate_button_in_live_video

boolean

[en] Whether the user can add a Donate Button to their Live Videos

talking_about_count

int

[en] The number of people talking about this Page

temporary_status

text

[en] Indicates how the business corresponding to this Page is operating differently than usual. Possible values: differently_open, temporarily_closed, operating_as_usual, no_data

unread_message_count

int

[en] Unread message count for the Page. Only visible to a page admin

unread_notif_count

int

[en] Number of unread notifications. Only visible to a page admin

unseen_message_count

int

[en] Unseen message count for the Page. Only visible to a page admin

username

text

[en] The alias of the Page. For example, for www.facebook.com/platform the username is 'platform'

verification_status

text

[en] Showing whether this Page is verified. Value can be blue_verified or gray_verified, which represents that Facebook has confirmed that a Page is the authentic presence of the public figure, celebrity, or global brand it represents, or not_verified

website

text

[en] The URL of the Page's website

were_here_count

int

[en] The number of visits to this Page's location. If the Page setting Show map, check-ins and star ratings on the Page (under Page Settings > Page Info > Address) is disabled, then this value will also be disabled

whatsapp_number

text

[en] The Page's WhatsApp number

written_by

text

[en] The writer of the TV show. Applicable to TV Shows

facebook_pages__category_list

Field Type

category_list__id

text

[en] The name of the Page

category_list__name

text

page_id

text

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Page Posts

This pipeline is in beta mode. Let us know if you find any unexpected results.

Field Type

created_time

timestamp

[en] The time the post was initially published. For a post about a life event, this is the date and time of the life event

message

text

[en] The status message in the post

from__name

text

[en] The name of the Page, group, or event that created the post

from__id

text

[en] The id of the Page, group, or event that created the post

id

text

[en] The ID of the post

page_id

text

[en] The id of the Page we used to read the post

    Páginas > > id

updated_time

timestamp

[en] The time the post was last updated, which occurs when the post was created, edited, or a User comments on a post, expressed as a UNIX timestamp

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Page Metrics

This pipeline is in beta mode. Let us know if you find any unexpected results.

See more details about this pipeline and its configuration by clickinghere.

Post metrics

This pipeline is in beta mode. Let us know if you find any unexpected results.

All post metrics are read considering the entire post existence period. This way, the number of impressions, for example, will indicate how many impressions the post had in its entire existence. To make it easy to store metrics history, we've added a metric_date column, which will indicate the date that that metric for that post was taken. Also, some metrics (eg views by country) populate more than one row, so we create a secondary table (“details”) that will contain these multi-row metrics. Simple metrics (which return just one row) will be contained in the main object's table. A listing and description of the multiline metrics that are returned can be found at the end of this section.

To avoid a complete reading of all posts at each execution – and also considering that very old posts no longer suffer modifications in their metrics, since they may not even be displayed anymore – the pipeline also allows you to configure a window of update that indicates how many days after the creation of the post your metrics should continue to be updated.

Main object

Campo Tipo

metric_date

date

[en] The UTC date when this record was read from the API

post_id

text

[en] The id of the post

    Páginas: lista de posts > > id

page_id

text

[en] The id of the page

post_engaged_users

float

[en] The number of people who clicked anywhere in your posts

post_negative_feedback

float

[en] The number of times people took a negative action in your post (e.g. hid it)

post_negative_feedback_unique

float

[en] The number of people who took a negative action in your post (e.g., hid it).

post_engaged_fan

float

[en] People who have liked your Page and engaged with your post.

post_clicks

float

[en] The number of times people clicked on anywhere in your posts without generating a story

post_clicks_unique

float

[en] The number of people who clicked anywhere in your post without generating a story

post_impressions

float

[en] The number of times your Page's post entered a person's screen. Posts include statuses, photos, links, videos and more

post_impressions_unique

float

[en] The number of people who had your Page's post enter their screen. Posts include statuses, photos, links, videos and more

post_impressions_paid

float

[en] The number of times your Page's post entered a person's screen through paid distribution such as an ad

post_impressions_paid_unique

float

[en] The number of people who had your Page's post enter their screen through paid distribution such as an ad

post_impressions_fan

float

[en] The number of impressions for your Page post by people who have liked your Page

post_impressions_fan_unique

float

[en] The number of people who have like your Page who saw your Page post

post_impressions_organic

float

[en] The number of times your Page's posts entered a person's screen through unpaid distribution

post_impressions_organic_unique

float

[en] The number of people who had your Page's post enter their screen through unpaid distribution

post_impressions_viral

float

[en] The number of times your Page's post entered a person's screen with social information attached. Social information displays when a person's friend interacted with you Page or post. This includes when someone's friend likes or follows your Page, engages with a post, shares a photo of your Page and checks into your Page

post_impressions_viral_unique

float

[en] The number of people who had your Page's post enter their screen with social information attached. As a form of organic distribution, social information displays when a person's friend interacted with you Page or post. This includes when someone's friend likes or follows your Page, engages with a post, shares a photo of your Page and checks into your Page

post_impressions_nonviral

float

[en] The number of times your Page's post entered a person's screen. This does not include content created about your Page with social information attached. Social information displays when a person's friend interacted with you Page or post. This includes when someone's friend likes or follows your Page, engages with a post, shares a photo of your Page and checks into your Page

post_impressions_nonviral_unique

float

[en] The number of people who had your Page's post enter their screen. This does not include content created about your Page with social information attached. As a form of organic distribution, social information displays when a person's friend interacted with you Page or post. This includes when someone's friend likes or follows your Page, engages with a post, shares a photo of your Page and checks into your Page

post_video_complete_views_30s_autoplayed

float

[en] The number of times your videos automatically played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_30s_clicked_to_play

float

[en] The number of times your videos played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_30s_organic

float

[en] The number of times your videos played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_30s_paid

float

[en] The number of times your promoted videos played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_30s_unique

float

[en] The number of people who viewed your videos for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_avg_time_watched

float

[en] The average time, in milliseconds, people viewed your videos. Only available for videos created after August 25th 2016. Returns 0 for reshared videos

post_video_complete_views_organic

float

[en] The number of times your videos played from the beginning to 95%, or more, of its length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_organic_unique

float

[en] The number of people who viewed your videos from the beginning to 95%, or more, of its length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_paid

float

[en] The number of times your promoted videos played from the beginning to 95%, or more, of its length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video. Returns 0 for reshared videos

post_video_complete_views_paid_unique

float

[en] The number of people who viewed your promoted videos from the beginning to 95%, or more, of its length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video

post_video_views_organic

float

[en] The number of times your videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_organic_unique

float

[en] The number of people who viewed your videos for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_paid

float

[en] The number of times your promoted videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video

post_video_views_paid_unique

float

[en] The number of people who viewed your promoted videos for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video

post_video_length

float

[en] The length, in milliseconds, of a video post

post_video_views

float

[en] The number of times your videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. This includes live views

post_video_views_unique

float

[en] The number of people who viewed your videos for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_autoplayed

float

[en] The number of times your videos automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_clicked_to_play

float

[en] The number of times your videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_15s

float

[en] The number of times your videos played for at least 15 seconds, or for nearly their total length if they're shorter than 15 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_60s_excludes_shorter

float

[en] The number of times your videos played for at least 60 seconds. This metric is counted only for videos that are 60 seconds or longer. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_10s

float

[en] The number of times your videos played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_10s_unique

float

[en] The number of people who viewed your videos for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video

post_video_views_10s_autoplayed

float

[en] The number of times your videos played automatically for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_10s_clicked_to_play

float

[en] The number of times your videos played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_10s_organic

float

[en] The number of times your videos played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_10s_paid

float

[en] The number of times your promoted videos played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video

post_video_views_10s_sound_on

float

[en] The number of times your videos played with sound on for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_views_sound_on

float

[en] The number of times your videos played with sound on for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video

post_video_view_time

float

[en] The total time, in milliseconds, your videos played, including videos played for less than 3 seconds and replays. Returns 0 for reshared videos

post_video_view_time_organic

float

[en] The total time, in milliseconds, your videos played by organic reach. Returns 0 for reshared videos

post_activity

float

[en] The number of stories generated about your Page post ('Stories')

post_video_ad_break_ad_impressions

float

[en] The total number of times an ad was shown during ad breaks in your videos

post_video_ad_break_earnings

float

[en] An estimate of the amount you earned from ad breaks in your videos, based on the number of impressions and CPM of ads shown. Actual payments may differ if there are content ownership claims or other adjustments

post_video_ad_break_ad_cpm

float

[en] The average amount paid by advertisers for 1,000 impressions of their ads in your videos. This number also includes the amount paid to Facebook

facebook_pages_metrics_details

Campo Tipo

metric_date

date

[en] The UTC date when this record was read from the API

post_id

text

[en] The id of the post

page_id

text

[en] The id of the page

metric

text

[en] The name of the metric

detail

text

[en] The detail of the metric

metric_detail_value

float

[en] The value of the detail of the metric

Muli-line metrics returned in "details"

post_negative_feedback_by_type: The number of times people took a negative action in your post broken down by type

post_negative_feedback_by_type_unique: The number of people who took a negative action in your post broken down by type

post_clicks_by_type: The number of times people clicked on anywhere in your posts without generating a story, by consumption type

post_clicks_by_type_unique: The number of people who clicked anywhere in your post without generating a story, by consumption type

post_impressions_by_story_type: The number of times this post was seen via a story published by a friend of the person viewing the post

post_impressions_by_story_type_unique: The number of people who saw your Page post in a story from a friend, by story type

post_reactions_by_type_total: Total post reactions by type

post_video_retention_graph: The number of times your videos played at each interval as a percentage of all views. Videos are divided into 40 equal intervals. This metric does not count impressions while the video was live. Retention graphs may show more impressions later in the video than at the beginning. People might start the video in the middle, skip ahead, save, and rewatch it from that point, or other similar behaviors

post_video_retention_graph_clicked_to_play: The number of times your videos played at each interval as a percentage of all views, after people clicked play. Videos are divided into 40 equal intervals. This metric does not count impressions while the video was live. Retention graphs may show more impressions later in the video than at the beginning. People might start the video in the middle, skip ahead, save, and rewatch it from that point, or other similar behaviors

post_video_retention_graph_autoplayed: The number of times your videos automatically played at each interval as a percentage of all automatic views. Videos are divided into 40 equal intervals.This metric does not count impressions while the video was live. Retention graphs may show more impressions later in the video than at the beginning. People might start the video in the middle, skip ahead, save, and rewatch it from that point, or other similar behaviors

post_video_view_time_by_age_bucket_and_gender: The total time, in milliseconds, your videos played for your Top Audiences, age and gender

post_video_view_time_by_region_id: The total time, in milliseconds, your videos played for your Top 45 Locations, Region - Country

post_video_views_by_distribution_type: The number of times your videos played by distribution type; page_owned and shared

post_video_view_time_by_distribution_type: The total time, in milliseconds, your videos played by distribution type; page_owned and shared

post_video_view_time_by_country_id: The total number of minutes your videos played for your Top 45 Locations; Country

post_activity_by_action_type: The number of stories created about your Page post, by action type

post_activity_by_action_type_unique: The number of people who created a story about your Page post, by action type

 

Understand the permissions and access levels that the account that was added on Kondado must have on facebook for this pipeline to work correctly

 

Post Comments

Field Type

id

text

[en] The comment ID

comment_count

float

[en] Number of replies to this comment

created_time

text

[en] The time this comment was made

like_count

float

[en] Number of times this comment was liked

message

text

[en] The comment text

post_id

text

[en] The post ID

 

This pipeline has been temporarily disabled

 

Notes

“Actions” are extra elements to ad analytics pipelines that provide additional information about the performance of actions taken on ads, such as off-site conversions and purchase data. The actions will be separated into 2 tables: actions and action_values. The actions table will represent data in count format (for example, number of purchases made on the website) while the action_values table will represent value data (for example, value of purchases made on the website).

ATTENTION: Do not mistake the actions_value column of the actions table with the action_values table

The actions and action_values tables have the same dimensions as the main statistics table (for example, if it is an pipeline of monthly campaign statistics by region, this will be the granularity of the actions records), in addition to fields that identify the action (columns actions_action_type and action_values_action_type, respectively) and quantify it (columns actions_value and action_values_value, respectively). Their values can also be found in the actions and action_values tables using the various assignment configurations (columns ending in 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click), which can be used for querying instead of the actions_value and action_values_value columns ( respectively) if you use a different attribution setting on your facebook account.

To know for sure if you should use the actions_value and action_values_value columns or any of the other attribution columns so that the result obtained is the same as the one presented in the tool's report, you can add the attribution setting column to the report obtained via facebook. Remembering that, if there is any indication that the configuration must be combined as “Click of 7 days or View of 1 day” you must add the respective columns in Kondado to obtain the same value of the tool. Our recommendation is to always use actions_value and action_values_value, follow the recommendation above only if you want the values to stay the same as the tool's default report

The actions_action_type and action_values_action_type that we have mapped are:

  • add_to_cart: Adds to Cart
  • app_custom_event.fb_mobile_achievement_unlocked: Mobile App Feature Unlocks
  • app_custom_event.fb_mobile_activate_app: Mobile App Starts
  • app_custom_event.fb_mobile_add_payment_info: Mobile App Payment Details
  • app_custom_event.fb_mobile_add_to_cart: Mobile App Adds To Cart
  • app_custom_event.fb_mobile_add_to_wishlist: Mobile App Adds to Wishlist
  • app_custom_event.fb_mobile_complete_registration: Mobile App Registrations
  • app_custom_event.fb_mobile_content_view: Mobile App Content Views
  • app_custom_event.fb_mobile_initiated_checkout: Mobile App Checkouts
  • app_custom_event.fb_mobile_level_achieved: Mobile App Achievements
  • app_custom_event.fb_mobile_purchase: Mobile App Purchases
  • app_custom_event.fb_mobile_rate: Mobile App Ratings
  • app_custom_event.fb_mobile_search: Mobile App Searchs
  • app_custom_event.fb_mobile_spent_credits: Mobile App Credit Spends
  • app_custom_event.fb_mobile_tutorial_completion: Mobile App Tutorial Completions
  • app_custom_event.other: Other Mobile App Actions
  • app_install: App Installs
  • app_use: App Uses
  • checkin: Check-ins
  • comment: Post Comments
  • credit_spent: Credit Spends
  • games.plays: Game Plays
  • initiate_checkout: Initiates Checkout
  • interactive_component_tap: Interactive Component Tap
  • landing_page_view: Landing Page Views
  • lead: All offsite leads plus all On-Facebook leads
  • like: Page Likes
  • link_click: Link Clicks
  • mobile_app_install: Mobile App Installs
  • offsite_conversion.custom.: Custom Conversions defined by the advertiser
  • offsite_conversion.fb_pixel_add_payment_info: Adds Payment Info
  • offsite_conversion.fb_pixel_add_to_cart: Adds To Cart
  • offsite_conversion.fb_pixel_add_to_wishlist: Adds To Wishlist
  • offsite_conversion.fb_pixel_complete_registration: Completed Registration
  • offsite_conversion.fb_pixel_custom: Custom pixel events defined by the advertiser
  • offsite_conversion.fb_pixel_initiate_checkout: Initiates Checkout
  • offsite_conversion.fb_pixel_lead: Leads
  • offsite_conversion.fb_pixel_purchase: Purchases
  • offsite_conversion.fb_pixel_search: Searchs
  • offsite_conversion.fb_pixel_view_content: Views Content
  • omni_add_to_cart: Adds to Cart
  • omni_initiated_checkout: Checkouts Initiated
  • omni_purchase: Purchases
  • omni_view_content: Content Views
  • onsite_conversion.flow_complete: On-Facebook Workflow Completions
  • onsite_conversion.messaging_block: Blocked Messaging Conversations
  • onsite_conversion.messaging_conversation_started_7d: Messaging Conversations Started
  • onsite_conversion.messaging_first_reply: New Messaging Conversations
  • onsite_conversion.post_save: Post Saves
  • onsite_conversion.purchase: On-Facebook Purchases
  • outbound_click: Outbound Clicks
  • page_engagement: Page Engagement
  • photo_view: Page Photo Views
  • post: Post Shares
  • post_engagement: Post Engagement
  • post_reaction: Post Reactions
  • purchase: Purchases
  • purchase_roas__omni_purchase: The total return on ad spend (ROAS) from purchases. This is based on information received from one or more of your connected Facebook Business Tools and attributed to your ads
  • rsvp: Event Responses
  • video_p100_watched_actions__video_view: The number of times your video was played at 100% of its length, including plays that skipped to this point
  • video_p25_watched_actions__video_view: The number of times your video was played at 25% of its length, including plays that skipped to this point
  • video_p50_watched_actions__video_view: The number of times your video was played at 50% of its length, including plays that skipped to this point
  • video_p75_watched_actions__video_view: The number of times your video was played at 75% of its length, including plays that skipped to this point
  • video_p95_watched_actions__video_view: The number of times your video was played at 95% of its length, including plays that skipped to this point
  • video_view: 3-Second Video Views
  • view_content: Content Views
  • website_purchase_roas__offsite_conversion.fb_pixel_purchase: The 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

By using breakdowns, some actions (e.g.: offsite, purchases, video_pXX_watched, etc)  might not be replicated. This is due to data aggregation between users with different privacy settings (eg IOS) return empty for those actions

If you choose to include a breakdown in your pipeline, the breakdown type will insert additional dimensions (columns) into statistics pipelines and further refine how data is returned. Are they:

Impression device + Device platform + Publisher platform + Platform position

  • publisher_platform (text): Which platform your ad was shown, for example on Facebook, Instagram, or Audience Network
  • impression_device (text): The device where your last ad was served to someone on Facebook. For example “iPhone” if someone viewed your ad on an iPhone
  • device_platform (text): The type of device, mobile or desktop, used by people when they viewed or clicked on an ad, as shown in ads reporting
  • platform_position (text): Where your ad was shown within a platform, for example on Facebook desktop News Feed, or Instagram Mobile News Feed

Region + Country

  • region (text): The regions where the people you’ve reached are located. This is based on information such as a person’s hometown, their current city and the geographical location where they tend to be when they visit Facebook
  • country (text): The countries where the people you’ve reached are located. This is based on information such as a person’s hometown, their current city and the geographical location where they tend to be when they visit Facebook

Age + Gender

  • age (text): The age range of the people you’ve reached
  • gender (text): Gender of people you’ve reached. People who don’t list their gender are shown as ‘not specified’

Hourly by advertiser time zone

Hourly breakdown aggregated by the time ads were delivered in the advertiser’s time zone. For example, if your ads are scheduled to run from 9 AM to 11 AM, but they reach audiences in multiple time zones, they may deliver from 9 AM to 1 PM in the advertiser’s time zone. Stats will be aggregated into four groups 9 AM – 10 AM, 10 AM – 11 AM, 11 AM – 12 PM, and 12 PM – 1 PM.

Hourly by audience time zone

Hourly breakdown aggregated by the time ads were delivered in the audiences’ time zone. For example, if your ads are scheduled to run from 9 AM to 11 AM but they reach audiences in multiple time zones, they may deliver from 9 AM to 1 PM in the advertiser’s time zone. Stats will be aggregated into two groups 9 AM – 10 AM and 10 AM – 11 AM.

After some privacy changes by operating system manufacturers (eg: iOS) Facebook is no longer able to accurately report actions that happen outside its platforms, such as those triggered by pixels. This way, when some detailing is used, the actions triggered by pixels will return null or even bring the value “unknown” to the detailing columns. So, if you want to have information on actions performed outside the platforms (that is, those that are not “impressions”, “like”, “click” and that are triggered by pixels such as “purchase” and “conversion”), we recommend that you you do not use any verbosity. See more information in facebook documentation

 

The period defines the granularity of the metric_date column. It is useful for better measuring some metrics of the “count distinct” type that can be different in a monthly sum (with monthly granularity) versus the sum of the days of the month (with daily granularity), for example unique_clicks – if the same user clicked on your ad every day of a month, it will be counted as one click per day at a daily granularity, but if added together, it will be considered 30 clicks for a month. The correct thing, in this case, would be to consider only 1 user click in the month, using the monthly period in the pipeline.

For the “lifetime” period, each execution will bring date_start 1110 days (37 months) prior to reading

 

This parameter indicates how many days before the savepoint the data will continue to be updated. This means that, with an pipeline that has a window of 7 days, at each execution, 7 days of results will be read. This window is useful if, in some situations, the “past” data can still be changed. As is the case with an external conversion by a user who was impacted by an ad but didn't actually convert until 3 days later – it's attributed as a conversion from 3 days ago, changed the past. You must leave this parameter according to the value of your facebook attribution window and adjust the frequency accordingly to avoid excessive consumption of your plan's records.

 

Permissions and access levels for Ads

The account that authorizes the facebook data source on Kondado must have:

  • At least employee access with view performance option enabled for the ad account the ad account analyst permission is also valid
  • If the profile is an agency profile, Page Admin permission is required
  • If the page is a “New Experience” type, “Partial Access” to the page is required
  • Understand how to add and manage users here
  • We also recommend that you give the page the permissions described here.

Permissions and access levels for pages

  • Admin access to the page is required
  • If using Business Manager, minimal Page editor access is required
  • If the page is of the “New Experience” type, a “Partial Access” to the page is required
  • If the profile is an agency profile, Page Admin permission is required
  • Understand how to add users using Business Manager
  • Understand how to manage access to your page