Creating the data source
Important
- This data source includes pipelines for Meta Ads, Instagram Ads, and Facebook Insights (organic data from pages and posts)
Instrctions
- Log into Kondado > Click the CREATE + button > Data Source > Facebook
- 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
- You will now be directed to a Facebook login page, where you must enter your credentials
- After logging in with your Facebook account linked to your Facebook Ads and/or Pages, grant Kondado permission by clicking Continue
- In the next step, select the account you wish to use and click Next
- On the permissions page, ensure all options are marked as Yes and click Finish
In the pipelines listed below, you can review the required permissions and access levels on Facebook that the account adding the Kondado data source must have
Pipelines
Summary
Relationship chart
Click to expand
Ad accounts
This pipeline is free
Replication type: Full
Parameters:
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
Static attributes and financial settings for the available ad accounts.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] The string act_{ad_account_id}. |
|
|
text |
[en] The ID of the Ad Account |
|
|
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 |
|
|
float |
[en] Amount of time the ad account has been open, in days. |
|
|
float |
[en] Current total amount spent by the account. This can be reset |
|
|
float |
[en] Bill amount due for this Ad Account. |
|
|
text |
[en] City for business address |
|
|
text |
[en] Country code for the business address |
|
|
text |
[en] The business name for the account |
|
|
text |
[en] State abbreviation for business address |
|
|
text |
[en] First line of the business street address for the account |
|
|
text |
[en] Second line of the business street address for the account |
|
|
text |
[en] Zip code for business address |
|
|
boolean |
[en] If we can create a new automated brand lift study under the Ad Account |
|
|
text |
[en] The time the account was created in ISO 8601 format |
|
|
text |
[en] The currency used for the account, based on the corresponding value in the account settings |
|
|
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 |
|
|
text |
[en] The entity the ads will target. Must be a Facebook Page Alias, Facebook Page ID or an Facebook App ID |
|
|
text |
[en] The name of the entity the ads will target |
|
|
float |
[en] The minimum daily budget for this Ad Account |
|
|
text |
[en] Name of the account. If not set, the name of the first admin visible to the user will be returned |
|
|
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 |
|
|
text |
[en] Tax ID |
|
|
text |
[en] Name for the time zone |
|
|
float |
[en] spend_cap minus amount_spent. Zero if no spending-cap (calculated by Kondado) |
|
|
float |
[en] kdd_remaining_from_spend_cap plus balance. Zero if no spending-cap (calculated by Kondado) |
Ad metadata
This pipeline is free
Replication type: Full
Parameters:
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
Relationships:
Configuration fields for each ad, including creative settings and delivery metadata.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] The ID of the ad |
|
|
text |
[en] The ID of the Ad Account |
|
|
text |
[en] ID of the ad set that contains the ad |
|
|
text |
[en] Name of the ad set that contains this ad |
|
|
text |
[en] ID of the ad campaign that contains this ad |
|
|
text |
[en] Name of the ad campaign that contains this ad |
|
|
timestamp |
[en] Time when the ad was created |
|
|
text |
[en] Name of the ad |
|
|
text |
[en] The source ad id that this ad is copied from (zero if not a copy) |
|
|
text |
[en] The configured status of the ad |
|
|
timestamp |
[en] Time when this ad was updated |
|
|
text |
[en] The actor ID (Page ID) of this creative |
|
|
text |
[en] The body of the ad. Not supported for video post creatives |
|
|
text |
[en] Type of call to action button in your ad. This determines the button text and header text for your ad |
|
|
text |
[en] Unique ID for an ad creative |
|
|
text |
[en] Name of this ad creative as seen in the ad account's library |
|
|
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) |
|
|
text |
[en] URL for a thumbnail image for this ad creative |
|
|
text |
[en] A URL for the image for this creative. We save the image at this URL to the ad account's image library |
|
|
text |
[en] First image URL from asset_feed_spec for Dynamic Ads. This is the actual product image URL, different from thumbnail_url which is the template. |
|
|
text |
[en] Title for link ad, which does not belong to a page |
Ad performance
- To use this pipeline effectively, understand more about actions, breakdown, períod and update window.
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this integration to function correctly
- Due to Facebook API limitations, this pipeline brings in data for a maximum period of 37 months (1110 days) in the past
- Due to Facebook API limitations, if a breakdown is used reach data older than 13 months won't be returned
Replication type: Incremental with update window
Parameters:
- Include action details tables?: Select On to include tables with details of actions and action values (1d_view,7d_view,28d_view,1d_click,7d_click and 28d_click)
- Period: The period breakdown of the performance. If daily, the field metric_date means the day, for weekly it means Monday and monthly it references the 1st day of the month
- Breakdown: Breakdown type
- Read start date (Savepoint): Data replication initial date
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
- Update window (days): How many days previous to the savepoint the same period will still be refreshed
Relationships:
Main object
Ad-level performance metrics per day for the selected account, respecting the chosen breakdowns and attribution window.
facebook_ad_insights_actions
Action counts per ad and day, with one column for each interaction type.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
||
|
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 |
|
|
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 |
|
|
text |
[en] The unique ID of the ad you're viewing in reporting |
|
|
text |
[en] The name of the ad you're viewing in reporting |
facebook_ad_insights_action_values
Monetary values for each action type per ad and day, aligned with the selected attribution window.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
||
|
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 |
|
|
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 |
|
|
text |
[en] The unique ID of the ad you're viewing in reporting |
|
|
text |
[en] The name of the ad you're viewing in reporting |
Ad preview
Replication type: Incremental with update window or Full (user configurable)
Parameters:
- Read start date (Savepoint): Initial date for data replication
- Update window (days): How many days previous to the savepoint the same records can still be updated
Relationships:
Ad set performance
- To use this pipeline effectively, understand more about actions, breakdown, períod and update window.
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this integration to function correctly
- Due to Facebook API limitations, this pipeline brings in data for a maximum period of 37 months (1110 days) in the past
- Due to Facebook API limitations, if a breakdown is used reach data older than 13 months won't be returned
Replication type: Incremental with update window
Parameters:
- Include action details tables?: Select On to include tables with details of actions and action values (1d_view,7d_view,28d_view,1d_click,7d_click and 28d_click)
- Period: The period breakdown of the performance. If daily, the field metric_date means the day, for weekly it means Monday and monthly it references the 1st day of the month
- Breakdown: Breakdown type
- Read start date (Savepoint): Data replication initial date
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
- Update window (days): How many days previous to the savepoint the same period will still be refreshed
Relationships:
Main object
Ad set level performance metrics per day for the selected account.
facebook_adset_insights_actions
Action counts grouped at the ad set level, with one column for each interaction type.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
||
|
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 |
|
|
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 |
facebook_adset_insights_action_values
Monetary values for actions aggregated per ad set and day.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
||
|
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 |
|
|
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 |
Campaign performance
- To use this pipeline effectively, understand more about actions, breakdown, períod and update window.
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this integration to function correctly
- Due to Facebook API limitations, this pipeline brings in data for a maximum period of 37 months (1110 days) in the past
- Due to Facebook API limitations, if a breakdown is used reach data older than 13 months won't be returned
Replication type: Incremental with update window
Parameters:
- Include action details tables?: Select On to include tables with details of actions and action values (1d_view,7d_view,28d_view,1d_click,7d_click and 28d_click)
- Period: The period breakdown of the performance. If daily, the field metric_date means the day, for weekly it means Monday and monthly it references the 1st day of the month
- Breakdown: Breakdown type
- Read start date (Savepoint): Data replication initial date
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
- Update window (days): How many days previous to the savepoint the same period will still be refreshed
Relationships:
Main object
Campaign level performance metrics per day for the selected account.
facebook_campaign_insights_actions
Action counts grouped at the campaign level, broken out by interaction type.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
facebook_campaign_insights_action_values
Monetary values for campaign actions per day and interaction type.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
||
|
text |
||
|
text |
Lead forms
Attention: for this pipeline to function correctly, the account used to create the connector in Kondado must be a page administrator and have permission to access leads. Learn more by clicking here and here
The permission to manage leads is granted by default to all page administrators but may have been changed from this default setting. By accessing business.facebook.com > Settings (bottom left) > Business Settings > Integrations > Lead Access – if you see a page similar to the image below, then access is granted to all page administrators (default):
However, if the page is similar to the other image below, you will need to add the Facebook user who authenticated the Kondado connector to the list using the button indicated in the image 
- Due to Facebook API limitations, this pipeline brings in data for a maximum period of 37 months (1110 days) in the past
Replication type: Incremental with update window
Parameters:
- Read start date (Savepoint): Initial date for data replication
- Update window (days): How many days previous to the savepoint the same records can still be updated
Relationships:
Main object
Lead submissions captured through lead ads, including metadata about campaigns, forms, and timestamps.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] ID of the lead |
|
|
text |
[en] Ad ID for the Lead Ad |
|
|
text |
[en] Ad name for the Lead Ad |
|
|
text |
[en] Ad Set ID for the Lead Ad |
|
|
text |
[en] Ad Set name for the Lead Ad |
|
|
text |
[en] Campaign ID for the Lead Ad |
|
|
text |
[en] Campaign name for the Lead Ad |
|
|
timestamp |
[en] Time this object was created |
|
|
text |
[en] Form ID used for the Lead Ads |
|
|
boolean |
[en] Indicates whether the lead is organic |
|
|
text |
[en] The platform attributed to the Lead |
facebook_leads__field_data
Form responses for each lead, listing every question and the value provided.
Page metrics
- See more details about this pipeline and its configuration by clicking here
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this pipeline to function correctly
Replication type: Incremental with update window
Parameters:
- Read start date (Savepoint): Initial date for data replication
- Metrics: Select which metrics to use. Consult our documentation for more details about each
- Pages: Filter which pages should be included or leave it empty to include all pages
- Update window (days): How many days previous to the savepoint the records should be updated
Relationships:
Page: posts
Replication type: Incremental with update window
Parameters:
- Read start date (Savepoint): Initial date for data replication
- Pages: Filter which pages to include or leave it empty to include all
- Update window (days): How many days previous to the savepoint the data should be updated
Relationships:
Published posts for the selected pages with message content and publishing context.
| Campo | Tipo | |
|---|---|---|
|
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 |
|
|
text |
[en] The status message in the post |
|
|
text |
[en] The name of the Page, group, or event that created the post |
|
|
text |
[en] The id of the Page, group, or event that created the post |
|
|
text |
[en] The ID of the post |
|
|
text |
[en] The id of the Page we used to read the post |
|
|
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 |
|
|
text |
[en] Type of the post attachment (photo, video, video_inline, album, link, share, etc) |
|
|
text |
[en] Media type of the post attachment (photo, video, album, link, etc) |
|
|
text |
[en] The permanent URL to this post |
Pages
Main object
Page level attributes and settings for the selected business pages.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] The ID representing a Facebook Page |
|
|
text |
[en] The Page's category. e.g. Product/Service, Computers/Technology |
|
|
text |
[en] tasks on the page, such as ADVERTISE |
|
|
text |
[en] The name of the Page |
|
|
text |
[en] Information about the Page. This value maps to the Description setting in the Edit Page Info user interface |
|
|
text |
[en] Affiliation of this person. Applicable to Pages representing people |
|
|
text |
[en] Artists the band likes. Applicable to Bands |
|
|
text |
[en] Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified |
|
|
text |
[en] The awards information of the film. Applicable to Films |
|
|
text |
[en] Band interests. Applicable to Bands |
|
|
text |
[en] Members of the band. Applicable to Bands |
|
|
text |
[en] Biography of the band. Applicable to Bands |
|
|
date |
[en] Birthday of this person. Applicable to Pages representing people |
|
|
text |
[en] Booking agent of the band. Applicable to Bands |
|
|
text |
[en] Year vehicle was built. Applicable to Vehicles |
|
|
boolean |
[en] Whether the Page has checkin functionality enabled |
|
|
float |
[en] Number of checkins at a place represented by a Page |
|
|
float |
[en] If this is a Page in a Global Pages hierarchy, the number of people who are being directed to this Page |
|
|
text |
[en] Culinary team of the business. Applicable to Restaurants or Nightlife |
|
|
text |
[en] Current location of the Page |
|
|
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 |
|
|
text |
[en] The director of the film. Applicable to Films |
|
|
text |
[en] Subtext about the Page being viewed |
|
|
text |
[en] Page estimated message response time displayed to user |
|
|
text |
[en] The emails listed in the About section of a Page |
|
|
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 |
|
|
text |
[en] Features of the vehicle. Applicable to Vehicles |
|
|
float |
[en] Number of page followers |
|
|
text |
[en] The restaurant's food styles. Applicable to Restaurants |
|
|
int |
[en] When the company was founded. Applicable to Pages in the Company category |
|
|
text |
[en] General information provided by the Page |
|
|
text |
[en] General manager of the business. Applicable to Restaurants or Nightlife |
|
|
text |
[en] The genre of the film. Applicable to Films |
|
|
text |
[en] The name of the Page with country codes appended for Global Pages |
|
|
text |
[en] This brand's global Root ID |
|
|
boolean |
[en] indicates whether a page has transitioned to new page experience or not |
|
|
boolean |
[en] Indicates whether WhatsApp number connected to this page is a WhatsApp business number |
|
|
boolean |
[en] Indicates whether WhatsApp number connected to this page is a WhatsApp number |
|
|
text |
[en] Hometown of the band. Applicable to Bands |
|
|
text |
[en] Time the business opens on Monday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Monday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Monday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Monday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Tuesday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Tuesday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Tuesday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Tuesday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Wednesday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Wednesday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Wednesday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Wednesday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Thursday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Thursday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Thursday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Thursday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Friday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Friday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Friday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Friday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Saturday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Saturday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Saturday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Saturday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Sunday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Sunday (first range). If always open, see is_always_open |
|
|
text |
[en] Time the business opens on Sunday (second range). If always open, see is_always_open |
|
|
text |
[en] Time the business closes on Sunday (second range). If always open, see is_always_open |
|
|
text |
[en] Legal information about the Page publishers |
|
|
text |
[en] Influences on the band. Applicable to Bands |
|
|
boolean |
[en] Indicates whether this location is always open |
|
|
boolean |
[en] Indicates whether location is part of a chain |
|
|
boolean |
[en] Indicates whether the Page is a community Page |
|
|
boolean |
[en] Indicates whether the page is eligible for the branded content tool |
|
|
boolean |
[en] Indicates whether the page is a Messenger Platform Bot with Get Started button enabled |
|
|
boolean |
[en] Indicates whether the page is a Messenger Platform Bot |
|
|
boolean |
[en] Indicates whether Page is owned |
|
|
boolean |
[en] Whether the business corresponding to this Page is permanently closed |
|
|
boolean |
[en] Indicates whether the Page is published and visible to non-admins |
|
|
boolean |
[en] Indicates whether the Page is unclaimed |
|
|
text |
[en] The Page's Facebook URL |
|
|
text |
[en] Members of this org. Applicable to Pages representing Team Orgs |
|
|
text |
[en] The default ice breakers for a certain page |
|
|
text |
[en] The default quick replies for a certain page |
|
|
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 |
|
|
text |
[en] The company mission. Applicable to Companies |
|
|
text |
[en] MPG of the vehicle. Applicable to Vehicles |
|
|
text |
[en] The TV network for the TV show. Applicable to TV Shows |
|
|
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 |
|
|
text |
[en] Personal information. Applicable to Pages representing People |
|
|
text |
[en] Personal interests. Applicable to Pages representing People |
|
|
text |
[en] Pharmacy safety information. Applicable to Pharmaceutical companies |
|
|
text |
[en] Pharmacy safety information. Applicable to Pharmaceutical companies |
|
|
text |
[en] List of pickup options available at this Page's store location. Values can include CURBSIDE, IN_STORE, and OTHER |
|
|
text |
[en] For places, the category of the place. Value can be CITY, COUNTRY, EVENT, GEO_ENTITY, PLACE, RESIDENCE, STATE_PROVINCE, or TEXT |
|
|
text |
[en] The plot outline of the film. Applicable to Films |
|
|
text |
[en] Press contact information of the band. Applicable to Bands |
|
|
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 |
|
|
text |
[en] Privacy url in page info section |
|
|
text |
[en] The productor of the film. Applicable to Films |
|
|
text |
[en] The products of this company. Applicable to Companies |
|
|
text |
[en] Public transit to the business. Applicable to Restaurants or Nightlife |
|
|
int |
[en] Number of ratings for the Page (limited to ratings that are publicly accessible) |
|
|
text |
[en] Record label of the band. Applicable to Bands |
|
|
text |
[en] The film's release date. Applicable to Films |
|
|
text |
[en] The air schedule of the TV show. Applicable to TV Shows |
|
|
text |
[en] The screenwriter of the film. Applicable to Films |
|
|
text |
[en] The season information of the TV Show. Applicable to TV Shows |
|
|
text |
[en] The Page address, if any, in a simple single line format |
|
|
text |
[en] The cast of the film. Applicable to Films |
|
|
text |
[en] Unique store code for this location Page |
|
|
text |
[en] Location Page's store location descriptor |
|
|
text |
[en] Unique store number for this location Page |
|
|
text |
[en] The studio for the film production. Applicable to Films |
|
|
boolean |
[en] Whether the user can add a Donate Button to their Live Videos |
|
|
int |
[en] The number of people talking about this Page |
|
|
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 |
|
|
int |
[en] Unread message count for the Page. Only visible to a page admin |
|
|
int |
[en] Number of unread notifications. Only visible to a page admin |
|
|
int |
[en] Unseen message count for the Page. Only visible to a page admin |
|
|
text |
[en] The alias of the Page. For example, for www.facebook.com/platform the username is 'platform' |
|
|
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 |
|
|
text |
[en] The URL of the Page's website |
|
|
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 |
|
|
text |
[en] The Page's WhatsApp number |
|
|
text |
[en] The writer of the TV show. Applicable to TV Shows |
facebook_pages__category_list
Additional categories associated with each page.
| Campo | Tipo | |
|---|---|---|
|
text |
||
|
text |
[en] The ID of the category |
|
|
text |
[en] The name of the category |
facebook_pages_followers_count_history
Historical daily snapshots of page followers count. One row per page per day.
| Campo | Tipo | |
|---|---|---|
|
date |
[en] Date of the followers count snapshot. |
|
|
text |
[en] The ID of the Facebook Page. |
|
|
float |
[en] Number of page followers on the given date. |
Post metrics
- All post metrics are read considering the entire period of the post's existence. For example, the number of impressions will indicate how many impressions the post has had over its entire lifespan. To facilitate storing the history of metrics, we added a
metric_datecolumn, which will indicate the date on which that metric for the post was obtained. Additionally, some metrics (such as views by country) populate more than one row, so we created a secondary table ("details") to hold these multi-row metrics. Simple metrics (which return only one row) will be contained in the main object table. A list and description of the multi-row metrics returned can be found at the end of this section - To avoid a complete read of all posts during each execution – and considering that very old posts no longer have changing metrics as they may no longer be displayed – the pipeline also allows you to configure an update window indicating how many days after a post’s creation its metrics should continue to be updated
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this pipeline to function correctly
Multi-row metrics returned in details
Replication type: Incremental with update window
Parameters:
- Replicate posts published since: Initial date for data replication
- Pages: Filter which pages should be included or leave it empty to include all
- Update window after publication (days): How many days after publication the same post should still be updated
Relationships:
Main object
Aggregated metrics with one row per selected object and date.
| Campo | Tipo | |
|---|---|---|
|
date |
[en] The UTC date when this record was read from the API |
|
|
text |
[en] The id of the post |
|
|
text |
[en] The id of the page |
|
|
float |
[en] The number of times people clicked on anywhere in your posts without generating a story |
|
|
float |
[en] The number of people who had your Page's post enter their screen. Posts include statuses, photos, links, videos and more |
|
|
float |
[en] The number of people who had your Page's post enter their screen through paid distribution such as an ad |
|
|
float |
[en] The number of people who have like your Page who saw your Page post |
|
|
float |
[en] The number of people who had your Page's post enter their screen through unpaid distribution |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
float |
[en] The length, in milliseconds, of a video post |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
float |
[en] The total time, in milliseconds, your videos played by organic reach. Returns 0 for reshared videos |
|
|
float |
[en] The number of stories generated about your Page post ('Stories') |
|
|
float |
[en] The total number of times an ad was shown during ad breaks in your videos |
|
|
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 |
|
|
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 |
|
|
float |
[en] Total number of likes on the post. Extracted from post_reactions_by_type_total (like type) |
|
|
float |
[en] Total number of reactions (sum of like, love, wow, haha, sorry, anger). Calculated from post_reactions_by_type_total |
|
|
float |
[en] Calculated engagement: total reactions + comments + shares + clicks. Industry standard formula used by analytics tools like Iconosquare and Social Status |
facebook_posts_metrics_details
Metric details for posts, storing the metric name, detail, and value per page and date.
| Campo | Tipo | |
|---|---|---|
|
date |
[en] The UTC date when this record was read from the API |
|
|
text |
[en] The id of the post |
|
|
text |
[en] The id of the page |
|
|
text |
[en] The name of the metric |
|
|
text |
[en] The detail of the metric |
|
|
float |
[en] The value of the detail of the metric |
Ad account performance
- To use this pipeline effectively, understand more about actions, breakdown, períod and update window.
- Understand the permissions and access levels that the account added to Kondado must have on Facebook for this integration to function correctly
- Due to Facebook API limitations, this pipeline brings in data for a maximum period of 37 months (1110 days) in the past
- Due to Facebook API limitations, if a breakdown is used reach data older than 13 months won't be returned
Replication type: Incremental with update window
Parameters:
- Include action details tables?: Select On to include tables with details of actions and action values (1d_view,7d_view,28d_view,1d_click,7d_click and 28d_click)
- Period: The period breakdown of the performance. If daily, the field metric_date means the day, for weekly it means Monday and monthly it references the 1st day of the month
- Breakdown: Breakdown type
- Read start date (Savepoint): Data replication initial date
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
- Update window (days): How many days previous to the savepoint the same period will still be refreshed
Relationships:
Main object
Account level performance metrics per day covering all campaigns in the selected account.
facebook_adaccount_insights_actions
Account level action counts with one column per interaction type.
| Campo | Tipo | |
|---|---|---|
|
date |
||
|
text |
||
|
text |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
float |
||
|
text |
facebook_adaccount_insights_action_values
Account level monetary values associated with each interaction type.
Adset metadata
This pipeline is free
Replication type: Full
Parameters:
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
Relationships:
Adset-level metadata including budgets, targeting, and promoted objects.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] The ID of the adset |
|
|
text |
[en] The name of the adset |
|
|
text |
[en] The ID of the ad account |
|
|
text |
[en] The ID of the campaign |
|
|
text |
[en] The configured status of the adset |
|
|
text |
[en] The user-set status |
|
|
text |
[en] The effective status considering parent campaign status. Values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_CHANGES, DISAPPROVED_INELIGIBLE, ARCHIVED, CAMPAIGN_PAUSED, IN_PROCESS, WITH_ISSUES |
|
|
text |
[en] The bid strategy. Values: LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, TARGET_COST, COST_CAP |
|
|
text |
[en] The billing event. Values: APP_INSTALLS, IMPRESSIONS, LINK_CLICKS, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, THRUPLAY, VIDEO_VIEWS_2, EVENT_RESPONSES, MESSAGING_BLOCK_PURCHASED, MESSAGING_DELIVERY_RESPONSE_24 |
|
|
text |
[en] The optimization goal. Values: APP_INSTALLS, AD_RECALL_LIFT, AWARENESS, ENGAGED_USERS, EVENT_RESPONSES, IMPRESSIONS, LEAD_GENERATION, LINK_CLICKS, NONE, OFFSITE_CONVERSIONS, PAGE_LIKES, POST_ENGAGEMENT, QUALITY_CALLS, QUALITY_LEAD, REACH, REPLIES, THRUPLAY, TRAVEL_INTENT, VALUE, VIDEO_VIEWS, VISIT_INSTAGRAM_PROFILE, CONVERSION_RATE, LANDING_PAGE_VIEWS, MESSAGING_APPOINTMENT_CONVERSION, MESSAGING_BUSINESS_REPLY_CONVERSION, MESSAGING_BUSINESS_RESULT |
|
|
text |
[en] The daily budget in cents |
|
|
text |
[en] The lifetime budget in cents |
|
|
text |
[en] The remaining budget in cents |
|
|
text |
[en] The custom event type for conversion optimization. Values: ACHIEVEMENT_UNLOCKED, AD_IMPRESSION, COMPLETED_REGISTRATION, CONTACT, CUSTOM, DONATE, LEVEL_ACHIEVED, PAGE_VIEW, PURCHASE, SCHEDULE, SEARCH, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, VIEW_CONTENT, OTHER |
|
|
text |
[en] The Pixel ID for conversion campaigns |
|
|
text |
[en] The Page ID for page-like campaigns |
|
|
text |
[en] The Application ID for app install campaigns |
|
|
text |
[en] The app store URL |
|
|
timestamp |
[en] The start time of the adset |
|
|
timestamp |
[en] The end time of the adset |
|
|
timestamp |
[en] The creation time |
|
|
timestamp |
[en] The last update time |
|
|
text |
[en] The targeting specifications for the adset (JSON object with geo_locations, age, gender, interests, behaviors, etc.) |
|
|
text |
[en] The targeting optimization types |
|
|
text |
[en] The bid amount in cents (used when bid_strategy is not LOWEST_COST_WITHOUT_CAP) |
|
|
text |
[en] The budget schedule specifications for lifetime budget adsets |
|
|
text |
[en] The Custom Conversion ID for conversion optimization campaigns |
|
|
text |
[en] The destination type. Values: ON_PAGE, OFF_PAGE, ON_AD, ON_MESSAGE, ON_PAGE_WHATSAPP, ON_WHATSAPP, APPLINKS_NO_BROWSER, APPLINKS_WITH_BROWSER |
|
|
text |
[en] The attribution specification for conversion tracking (e.g., [{"event_type":"Omni-Activate","window_days":7}]) |
Campaign metadata
This pipeline is free
Replication type: Full
Parameters:
- Ad accounts: Filter which ad accounts should be included or leave it empty to include all
Relationships:
Campaign-level metadata including budgets, objectives, and schedules.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] The ID of the campaign |
|
|
text |
[en] The name of the campaign |
|
|
text |
[en] The ID of the ad account |
|
|
text |
[en] The configured status of the campaign |
|
|
text |
[en] The user-set status |
|
|
text |
[en] The effective status. Values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_CHANGES, DISAPPROVED_INELIGIBLE, ARCHIVED, IN_PROCESS, WITH_ISSUES |
|
|
text |
[en] The bid strategy at campaign level |
|
|
text |
[en] The buying type. Values: AUCTION, RESERVED, CHANNEL |
|
|
text |
[en] The campaign objective |
|
|
text |
[en] The daily budget in cents |
|
|
text |
[en] The lifetime budget in cents |
|
|
text |
[en] The remaining budget in cents |
|
|
text |
[en] The spend cap |
|
|
timestamp |
[en] The start time of the campaign |
|
|
timestamp |
[en] The stop time of the campaign |
|
|
timestamp |
[en] The creation time |
|
|
timestamp |
[en] The last update time |
|
|
text |
[en] The source campaign ID if copied |
|
|
text |
[en] The smart promotion type |
|
|
text |
[en] The topline ID |
|
|
text |
[en] The pacing type. Values: day_parting, standard, no_pacing |
|
|
text |
[en] The custom event type for conversion optimization |
|
|
text |
[en] The Pixel ID for conversion campaigns |
|
|
text |
[en] The Page ID for page-like campaigns |
|
|
text |
[en] The Application ID for app install campaigns |
|
|
text |
[en] The app store URL |
Notes
Important Information About Accounts and Pages
Clients with many ad accounts or pages: If your Facebook connector has access to more than 10 ad accounts or pages, and you manually specify which accounts/pages to integrate, the integration will continue working even if access to one of the accounts/pages is lost. The system will log the error and continue fetching data from the remaining accounts/pages. This ensures your integrations do not completely fail if you lose access to a specific account or page.
This behavior applies to: Ad Insights, Ad Set Insights, Campaign Insights, Page Metrics, Post Metrics, and Page Posts integrations.
Actions and Action Values
"Actions" are additional elements to ad performance pipelines, providing extra information on ad performance metrics, such as conversions occurring off-site and purchase data. These actions are organized into two tables: actions and action_values. The actions table displays data as counts (e.g., number of purchases on the site), while the action_values table shows value data (e.g., purchase values on the site).
NOTE: Do not confuse the actions_value column in the actions table with the action_values table.
The actions and action_values tables have the same dimensions as the main performance table (for example, if it’s a monthly campaign performance pipeline by region, this will be the granularity of the actions records). They also include fields identifying the action (columns actions_action_type and action_values_action_type, respectively) and quantifying it (columns actions_value and action_values_value, respectively). In the actions and action_values tables, you will also find values using various attribution settings (columns ending in 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click), which can be used instead of the actions_value and action_values_value columns if you use a different attribution setting on your Facebook account.
To ensure you’re using the correct columns for results that match the tool’s report, add the attribution setting column to the report obtained via Facebook. If the report specifies an attribution setting like "7-day Click or 1-day View," combine the respective columns in Kondado to match the tool’s values. However, we recommend using actions_value and action_values_value unless you need exact alignment with the standard report’s values.
We have also included in the main table the default value (without listing the various attribution settings) of available actions. Actions fields are prefixed with “a_” and action_values fields with “value_” in the field names of the main table
The mapped actions_action_type and action_values_action_type are as follows:
| Action | About | Table |
| add_payment_info | Occurs when a user adds payment information during a checkout process. | actions |
| add_to_cart | Triggered when a user adds a product to their shopping cart. | actions |
| add_to_wishlist | Happens when a user adds a product to their wishlist. | actions |
| app_custom_event | Represents a custom event defined within an app. | actions |
| app_custom_event.fb_mobile_achievement_unlocked | Indicates that a user has unlocked an achievement within a mobile app. | actions |
| app_custom_event.fb_mobile_activate_app | Marks the activation of a mobile app by a user. | actions |
| app_custom_event.fb_mobile_add_payment_info | Occurs when a user adds payment information within a mobile app. |
actions |
| app_custom_event.fb_mobile_add_to_cart | Triggered when a user adds an item to their cart within a mobile app. | actions |
| app_custom_event.fb_mobile_add_to_wishlist | Happens when a user adds an item to their wishlist within a mobile app. | actions |
| app_custom_event.fb_mobile_complete_registration | Indicates that a user has completed the registration process within a mobile app. | actions |
| app_custom_event.fb_mobile_content_view | Marks when a user views content within a mobile app. | actions |
| app_custom_event.fb_mobile_d2_retention | Represents a user returning to the app on the second day after installation. | actions |
| app_custom_event.fb_mobile_d7_retention | Represents a user returning to the app on the seventh day after installation. | actions |
| app_custom_event.fb_mobile_initiated_checkout | Occurs when a user initiates the checkout process within a mobile app. | actions |
| app_custom_event.fb_mobile_level_achieved | Indicates that a user has achieved a new level within a mobile app. | actions |
| app_custom_event.fb_mobile_purchase | Marks a purchase made within a mobile app. | actions |
| app_custom_event.fb_mobile_rate | Triggered when a user rates content within a mobile app. | actions |
| app_custom_event.fb_mobile_search | Happens when a user performs a search within a mobile app. | actions |
| app_custom_event.fb_mobile_spent_credits | Indicates that a user has spent credits within a mobile app. | actions |
| app_custom_event.fb_mobile_tutorial_completion | Marks the completion of a tutorial within a mobile app. | actions |
| app_custom_event.other | Represents other custom events defined within an app. | actions |
| app_engagement | Occurs when a user engages with an app, such as opening it or interacting with its features. | actions |
| app_install | Triggered when a user installs an app. | actions |
| call_confirm_grouped | Represents grouped call confirmations. | actions |
| checkin | Happens when a user checks in at a location. | actions |
| click_to_call_call_confirm | Occurs when a user confirms a call initiated through a click-to-call action. | actions |
| click_to_call_callback_request_submitted | Indicates that a user has submitted a callback request through a click-to-call action. | actions |
| click_to_call_native_20s_call_connect | Marks a call connection lasting at least 20 seconds initiated through a native click-to-call action. | actions |
| click_to_call_native_60s_call_connect | Marks a call connection lasting at least 60 seconds initiated through a native click-to-call action. | actions |
| click_to_call_native_call_placed | Occurs when a call is placed through a native click-to-call action. | actions |
| click_to_join_new_channel_member | Happens when a user joins a new channel through a click-to-join action. | actions |
| comment | Triggered when a user comments on a post. | actions |
| commerce_event | Represents events related to commerce activities, such as purchases or product views. | actions |
| complete_registration | Indicates that a user has completed a registration process. | actions |
| credit_spent | Marks the spending of credits by a user. | actions |
| group_join | Occurs when a user joins a group. | actions |
| initiate_checkout | Triggered when a user initiates the checkout process. | actions |
| interactive_component_tap | Happens when a user taps on an interactive component, such as a button or link. | actions |
| landing_page_view | Indicates that a user has viewed a landing page. | actions |
| lead | Represents the generation of a lead, such as when a user submits a form. | actions |
| leadgen_grouped | Represents grouped lead generation events. | actions |
| like | Occurs when a user likes a post or page. | actions |
| link_click | Triggered when a user clicks on a link. | actions |
| mobile_app_install | Marks the installation of a mobile app by a user. | actions |
| offline_conversion | Represents a conversion that occurred offline, such as an in-store purchase. | actions |
| offline_conversion.add_payment_info | Occurs when a user adds payment information offline. | actions |
| offline_conversion.add_to_cart | Triggered when a user adds an item to their cart offline. | actions |
| offline_conversion.add_to_wishlist | Happens when a user adds an item to their wishlist offline. | actions |
| offline_conversion.complete_registration | Indicates that a user has completed a registration process offline. | actions |
| offline_conversion.initiate_checkout | Occurs when a user initiates the checkout process offline. | actions |
| offline_conversion.lead | Represents the generation of a lead offline. | actions |
| offline_conversion.other | Represents other offline conversion events. | actions |
| offline_conversion.purchase | Marks a purchase made offline. | actions |
| offline_conversion.search | Happens when a user performs a search offline. | actions |
| offline_conversion.view_content | User views content offline. | actions |
| offsite_conversion | Conversion event occurring outside the platform, such as on an external website. | actions |
| offsite_conversion.fb_pixel_add_payment_info | User adds payment information on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_add_to_cart | User adds an item to their cart on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_add_to_wishlist | User adds an item to their wishlist on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_complete_registration | User completes registration on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_custom | Custom event tracked on an external site via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_initiate_checkout | User initiates checkout on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_lead | Lead generated on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_purchase | Purchase completed on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_search | User performs a search on an external site tracked via Facebook Pixel. | actions |
| offsite_conversion.fb_pixel_view_content | User views content on an external site tracked via Facebook Pixel. | actions |
| omni_achievement_unlocked | User unlocks an achievement across multiple platforms. | actions |
| omni_activate_app | User activates an app across multiple platforms. | actions |
| omni_add_to_cart | User adds an item to their cart across multiple platforms. | actions |
| omni_add_to_wishlist | User adds an item to their wishlist across multiple platforms. | actions |
| omni_app_install | User installs an app across multiple platforms. | actions |
| omni_complete_registration | User completes registration across multiple platforms. | actions |
| omni_custom | Custom event occurring across multiple platforms. | actions |
| omni_initiated_checkout | User initiates checkout across multiple platforms. | actions |
| omni_level_achieved | User achieves a new level across multiple platforms. | actions |
| omni_purchase | User completes a purchase across multiple platforms. | actions |
| omni_rate | User rates content across multiple platforms. | actions |
| omni_search | User performs a search across multiple platforms. | actions |
| omni_spend_credits | User spends credits across multiple platforms. | actions |
| omni_tutorial_completion | User completes a tutorial across multiple platforms. | actions |
| omni_view_content | User views content across multiple platforms. | actions |
| onsite_app_add_to_cart | User adds an item to their cart within an app on Facebook. | actions |
| onsite_app_purchase | User completes a purchase within an app on Facebook. | actions |
| onsite_app_view_content | User views content within an app on Facebook. | actions |
| onsite_conversion.add_to_cart | User adds an item to their cart directly on Facebook's platform. | actions |
| onsite_conversion.add_to_wishlist | User adds an item to their wishlist directly on Facebook's platform. | actions |
| onsite_conversion.click_to_call | User initiates a call through a click-to-call action on Facebook. | actions |
| onsite_conversion.donate | User makes a donation directly on Facebook. | actions |
| onsite_conversion.find_location | User searches for a location directly on Facebook. | actions |
| onsite_conversion.flow_complete | User completes a predefined flow (e.g., sign-up) on Facebook. | actions |
| onsite_conversion.initiate_checkout | User initiates the checkout process directly on Facebook. | actions |
| onsite_conversion.lead | Lead generated through Facebook's onsite actions. | actions |
| onsite_conversion.lead_grouped | Grouped lead generation events on Facebook. | actions |
| onsite_conversion.message_to_buy | User messages a business with purchase intent on Facebook. | actions |
| onsite_conversion.messaging_20s_call_connect | Messaging call connects for at least 20 seconds. | actions |
| onsite_conversion.messaging_60s_call_connect | Messaging call connects for at least 60 seconds. | actions |
| onsite_conversion.messaging_block | User blocks messaging from a business. | actions |
| onsite_conversion.messaging_business_calling_call_answered | Call answered from a business within Facebook Messenger. | actions |
| onsite_conversion.messaging_business_calling_call_initiated | Call initiated with a business in Facebook Messenger. | actions |
| onsite_conversion.messaging_business_calling_call_missed | Call missed from a business within Facebook Messenger. | actions |
| onsite_conversion.messaging_business_calling_opt_in_accepted | User accepts opt-in to receive calls from a business. | actions |
| onsite_conversion.messaging_business_calling_opt_in_denied | User denies opt-in to receive calls from a business. | actions |
| onsite_conversion.messaging_business_calling_opt_in_sent | Business sends opt-in request for calls. | actions |
| onsite_conversion.messaging_conversation_replied_7d | User replies to a business within 7 days. | actions |
| onsite_conversion.messaging_conversation_started_7d | Conversation started with a business within 7 days. | actions |
| onsite_conversion.messaging_first_reply | User's first reply to a business. | actions |
| onsite_conversion.messaging_order_created_v2 | User places an order through Facebook's messaging. | actions |
| onsite_conversion.messaging_order_shipped_v2 | User's order marked as shipped via Facebook messaging. | actions |
| onsite_conversion.messaging_user_call_placed | User places a call via messaging. | actions |
| onsite_conversion.messaging_user_conversation_depth_2_message_send | User sends two messages in a conversation on Facebook's platform. | actions |
| onsite_conversion.messaging_user_conversation_depth_3_message_send | User sends three messages in a conversation on Facebook's platform. | actions |
| onsite_conversion.messaging_user_depth_2_message_send | User sends at least two messages in an ongoing conversation on Facebook's platform. | actions |
| onsite_conversion.messaging_user_depth_3_message_send | User sends at least three messages in an ongoing conversation on Facebook's platform. | actions |
| onsite_conversion.messaging_user_depth_5_message_send | User sends at least five messages in an ongoing conversation on Facebook's platform. | actions |
| onsite_conversion.messaging_user_subscribed | User subscribes to messages from a business on Facebook's platform. | actions |
| onsite_conversion.messaging_welcome_message_view | User views a welcome message in Facebook messaging. | actions |
| onsite_conversion.other | Other onsite conversions on Facebook's platform. | actions |
| onsite_conversion.post_save | User saves a post on Facebook's platform. | actions |
| onsite_conversion.purchase | User completes a purchase directly on Facebook's platform. | actions |
| onsite_conversion.total_messaging_connection | Total connections made via messaging on Facebook's platform. | actions |
| onsite_conversion.view_content | User views content directly on Facebook's platform. | actions |
| onsite_web_add_to_cart | User adds an item to their cart on Facebook's web interface. | actions |
| onsite_web_app_add_to_cart | User adds an item to their cart within Facebook's web app. | actions |
| onsite_web_app_purchase | User completes a purchase within Facebook's web app. | actions |
| onsite_web_app_view_content | User views content within Facebook's web app. | actions |
| onsite_web_initiate_checkout | User initiates the checkout process on Facebook's web platform. | actions |
| onsite_web_lead | Lead generated on Facebook's web platform. | actions |
| onsite_web_purchase | Purchase completed on Facebook's web platform. | actions |
| onsite_web_view_content | Content viewed on Facebook's web platform. | actions |
| outbound_clicks__outbound_click | User clicks a link that directs them off Facebook's platform. | actions |
| page_engagement | User engages with a Facebook page (e.g., likes, comments, shares). | actions |
| photo_view | User views a photo on Facebook's platform. | actions |
| post | User creates a post on Facebook's platform. | actions |
| post_engagement | User engages with a post (e.g., reacts, shares, comments) on Facebook's platform. | actions |
| post_reaction | User reacts to a post with like, love, etc., on Facebook's platform. | actions |
| purchase | User completes a purchase. | actions |
| purchase_roas__omni_purchase | Return on ad spend for purchases across multiple platforms. | actions |
| rsvp | User RSVPs to an event on Facebook's platform. | actions |
| search | User performs a search on Facebook's platform. | actions |
| video_p100_watched_actions__video_view | User watches 100% of a video on Facebook's platform. | actions |
| video_p25_watched_actions__video_view | User watches 25% of a video on Facebook's platform. | actions |
| video_p50_watched_actions__video_view | User watches 50% of a video on Facebook's platform. | actions |
| video_p75_watched_actions__video_view | User watches 75% of a video on Facebook's platform. | actions |
| video_p95_watched_actions__video_view | User watches 95% of a video on Facebook's platform. | actions |
| video_view | User views a video on Facebook's platform. | actions |
| view_content | User views content on Facebook's platform. | actions |
| web_in_store_purchase | Purchase made in-store but tracked online. | actions |
| website_purchase_roas | Return on ad spend for website purchases. | actions |
| website_purchase_roas__offsite_conversion.fb_pixel_purchase | Return on ad spend for purchases via Facebook Pixel offsite. | actions |
| app_use | User uses an app. | actions |
| games.plays | User plays a game. | actions |
| offsite_conversion.custom.<custom_conv_id> | Custom offsite conversion event. | actions |
| outbound_click | User clicks an outbound link. | actions |
| contact_total | Total contact actions by user across all sources. | actions |
| contact_website | Contact action taken on a website. | actions |
| contact_mobile_app | Contact action within a mobile app. | actions |
| contact_offline | Contact action taken offline. | actions |
| customize_product_total | Total product customizations by user across all sources. | actions |
| customize_product_website | Product customized on a website. | actions |
| customize_product_mobile_app | Product customized in a mobile app. | actions |
| customize_product_offline | Product customization offline. | actions |
| donate_total | Total donations made by user across all sources. | actions |
| donate_website | Donation made on a website. | actions |
| donate_on_facebook | Donation made on Facebook's platform. | actions |
| donate_mobile_app | Donation made in a mobile app. | actions |
| donate_offline | Donation made offline. | actions |
| find_location_total | Total times user searched for a location across all sources. | actions |
| find_location_website | Location search on a website. | actions |
| find_location_mobile_app | User searches for a location within a mobile app. | actions |
| find_location_offline | User searches for a location through offline means. | actions |
| schedule_total | Total scheduling actions taken by the user across all platforms. | actions |
| schedule_website | User schedules an appointment or event through a website. | actions |
| schedule_mobile_app | User schedules an appointment or event within a mobile app. | actions |
| schedule_offline | User schedules an appointment or event through offline methods. | actions |
| start_trial_total | Total instances where the user initiates a trial period across all platforms. | actions |
| start_trial_website | User initiates a trial period through a website. | actions |
| start_trial_mobile_app | User initiates a trial period within a mobile app. | actions |
| start_trial_offline | User initiates a trial period through offline methods. | actions |
| submit_application_total | Total applications submitted by the user across all platforms. | actions |
| submit_application_website | User submits an application through a website. | actions |
| submit_application_mobile_app | User submits an application within a mobile app. | actions |
| submit_application_offline | User submits an application through offline methods. | actions |
| submit_application_on_facebook | User submits an application directly on Facebook's platform. | actions |
| subscribe_total | Total subscriptions initiated by the user across all platforms. | actions |
| subscribe_website | User subscribes to a service or content through a website. | actions |
| subscribe_mobile_app | User subscribes to a service or content within a mobile app. | actions |
| subscribe_offline | User subscribes to a service or content through offline methods. | actions |
| recurring_subscription_payment_total | Total recurring subscription payments made by the user across all platforms. | actions |
| recurring_subscription_payment_website | Recurring subscription payment made through a website. | actions |
| recurring_subscription_payment_mobile_app | Recurring subscription payment made within a mobile app. | actions |
| recurring_subscription_payment_offline | Recurring subscription payment made through offline methods. | actions |
| cancel_subscription_total | Total instances where the user cancels a subscription across all platforms. | actions |
| cancel_subscription_website | User cancels a subscription through a website. | actions |
| cancel_subscription_mobile_app | User cancels a subscription within a mobile app. | actions |
| cancel_subscription_offline | User cancels a subscription through offline methods. | actions |
| ad_click_mobile_app | User clicks on an advertisement within a mobile app. | actions |
| ad_impression_mobile_app | User views an advertisement within a mobile app. | actions |
| add_payment_info | Total value from users adding payment information. | action_values |
| add_to_cart | Total value from users adding items to their cart. | action_values |
| add_to_wishlist | Total value from users adding items to their wishlist. | action_values |
| app_custom_event.fb_mobile_add_to_cart | Total value from mobile app users adding items to their cart. | action_values |
| app_custom_event.fb_mobile_add_to_wishlist | Total value from mobile app users adding items to their wishlist. | action_values |
| app_custom_event.fb_mobile_content_view | Total value from mobile app users viewing content. | action_values |
| app_custom_event.fb_mobile_initiated_checkout | Total value from mobile app users initiating the checkout process. | action_values |
| app_custom_event.fb_mobile_purchase | Total value from purchases made within the mobile app. | action_values |
| app_custom_event.fb_mobile_search | Total value from searches conducted within the mobile app. | action_values |
| app_custom_event.fb_mobile_spent_credits | Total value from credits spent within the mobile app. | action_values |
| app_custom_event.other | Total value from other custom events tracked within the app. | action_values |
| complete_registration | Total value from users completing registration forms. | action_values |
| initiate_checkout | Total value from users initiating the checkout process. | action_values |
| lead | Total value from lead generation activities. | action_values |
| offline_conversion.purchase | Total value from purchases recorded through offline conversion tracking. | action_values |
| offsite_conversion.fb_pixel_add_payment_info | Total value from users adding payment information tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_add_to_cart | Total value from users adding items to their cart tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_add_to_wishlist | Total value from users adding items to their wishlist tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_complete_registration | Total value from users completing registration forms tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_custom | Total value from custom conversions tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_initiate_checkout | Total value from users initiating the checkout process tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_lead | Total value from lead generation activities tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_purchase | Total value from purchases tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_search | Total value from searches conducted on the website tracked by the Facebook Pixel. | action_values |
| offsite_conversion.fb_pixel_view_content | Total value from content views tracked by the Facebook Pixel. | action_values |
| omni_add_to_cart | Total value from users adding items to their cart across all platforms. | action_values |
| omni_add_to_wishlist | Total value from users adding items to their wishlist across all platforms. | action_values |
| omni_complete_registration | Total value from users completing registration forms across all platforms. | action_values |
| omni_custom | Total value from custom actions across all platforms. | action_values |
| omni_initiated_checkout | Total value from users initiating the checkout process across all platforms. | action_values |
| omni_purchase | Total value from purchases across all platforms. | action_values |
| omni_search | Total value from searches conducted across all platforms. | action_values |
| omni_view_content | Total value from content views across all platforms. | action_values |
| onsite_app_add_to_cart | Total value from users adding items to their cart within the app. | action_values |
| onsite_app_purchase | Total value from purchases made within the app. | action_values |
| onsite_app_view_content | Total value from content views within the app. | action_values |
| onsite_conversion.purchase | Total value from purchases made on Facebook's platform. | action_values |
| onsite_web_add_to_cart | Total value from users adding items to their cart on the website. | action_values |
| onsite_web_app_add_to_cart | Total value from users adding items to their cart within the web app. | action_values |
| onsite_web_app_purchase | Total value from purchases made within the web app. | action_values |
| onsite_web_app_view_content | Total value from content views within the web app. | action_values |
| onsite_web_initiate_checkout | Total value from users initiating the checkout process on the website. | action_values |
| onsite_web_lead | Total value from lead generation activities on the website. | action_values |
| onsite_web_purchase | Total value from purchases made on the website. | action_values |
| onsite_web_view_content | Total value from content views on the website. | action_values |
| purchase | Total value from all purchases. | action_values |
| search | Total value from all searches conducted. | action_values |
| view_content | Total value from all content views. | action_values |
| web_in_store_purchase | Total value from in-store purchases recorded through web tracking. | action_values |
Breakdown
Using breakdowns can cause some actions (such as offsite actions, purchases, and video_pXX_watched) to no longer be returned due to privacy settings that prevent aggregation of these actions among users with stricter privacy controls (e.g., iOS devices). If your action is not returned, try checking its behavior in an integration without breakdowns.
If you choose to include a breakdown in your pipeline, the type of breakdown will add additional dimensions (columns) to performance pipelines and refine how data is returned. These are:
Impression Device + Device Platform + Publisher Platform + Platform Position
- publisher_platform: The platform where your ad appeared, like Facebook, Instagram, or Audience Network
- impression_device: The device where the last ad was served, for example, "iPhone" if viewed on an iPhone
- device_platform: The type of device, mobile or desktop, used when viewing or clicking on an ad, as shown in ad reports
- platform_position: Placement of your ad within a platform, such as Facebook desktop News Feed or Instagram Mobile News Feed
Region + Country
- region: Regions of the audience reached, based on data like hometown, current city, and frequent locations on Facebook
- country: Countries of the audience reached, using similar location-based data
Age + Gender
- age: Age range of the reached audience
- gender: Gender of the audience reached; unspecified genders are listed as 'not specified'
Hourly by Advertiser Time Zone
- Aggregates data by the time ads were delivered in the advertiser's time zone, broken into time intervals like 9 AM - 10 AM, 10 AM - 11 AM, etc.
Hourly by Audience Time Zone
- Aggregates data by the time ads reached audiences in their respective time zones, into intervals like 9 AM - 10 AM, 10 AM - 11 AM, etc.
N/A
- Indicates that there's no breakdown being applied
Due to privacy changes by operating system manufacturers (e.g., iOS), Facebook can no longer accurately report actions occurring outside its platforms, like those triggered by pixels. Therefore, when breakdowns are used, pixel-triggered actions may return as null or display "unknown" in breakdown columns. If you want information on off-platform actions (e.g., "purchase" or "conversion" triggered by pixels, not "impressions," "like," or "click"), we recommend avoiding any breakdown. For more details, see Facebook's documentation.
Period
The period defines the granularity of the metric_date column. It is useful for more accurate measurement of certain "count distinct" metrics, which may differ in a monthly total (with monthly granularity) compared to daily totals for a month (with daily granularity). For example, unique_clicks: if the same user clicks on your ad every day for a month, they will be counted as one click per day with daily granularity, but as 30 clicks for the month if summed. In this case, the correct approach would be to consider only one click for the user in the month by using monthly granularity in the pipeline.
For the "lifetime" period, each run will retrieve data starting 1,110 days (37 months) before the read date.
Update window
This parameter indicates how many days prior to the savepoint data will continue to be updated. For example, with a 7-day window, each run will read results from the past 7 days. This window is helpful when "past" data may still change. A typical case is an offsite conversion by a user who saw an ad but only converted three days later—the conversion is attributed to three days ago, altering the past. Set this parameter according to your Facebook attribution window and adjust the frequency to avoid excessive record consumption from your plan.
Permissions and Access Levels for Ads
The account authorizing the Facebook connector in Kondado must have:
- At least Employee access with the view performance option enabled for the ad account; Ad Account Analyst permission is also valid
- Page Admin permission if the profile is an agency
- Partial Access to the page if it’s a “New Experience” page type
- Refer to the guide on how to add and manage users here
- We also recommend granting the page permissions described here
Permissions and Access Levels for Pages
- Admin access to the page is required
- If using Business Manager, Page Editor access is the minimum required
- For "New Experience" pages, Partial Access to the page is necessary
- If the profile is an agency, Page Admin permission is needed
- Learn how to add users using Business Manager
- Learn how to manage access to your page
Ads Data Freshness
Ads data might take up to 5 days to be fully aggregated [1], [2]
⚠️ Meta Compliance Notice
Kondado’s Facebook and Instagram integrations comply with Meta’s Developer Policies (https://developers.facebook.com/devpolicy/ and https://developers.facebook.com/terms/)
Data obtained from Meta APIs (such as ad metrics, lead forms, and page insights) is intended solely for analytics and reporting within the advertiser’s own account or their authorized agency.
It is strictly prohibited to use this data to create or enrich individual profiles, perform retargeting, share it with third parties, or use it in any way not authorized by Meta.
Violation of these rules may result in suspension or termination of the user’s account.
This documentation was partially generated with the help of AI tools. While efforts have been made to ensure accuracy, some information may be incomplete or incorrect. Please verify critical details and consult additional resources if needed.
- Part of this documentation was automatically generated by AI and may contain errors. We recommend verifying critical information