Facebook

📘
Checkout the Facebook Ad Insights API docs for more information

Set up

To set up the source you just need a Facebook username and password for a user which has been added to the business account from which you would like to retrieve data. You will also need your account ID.

To find your account ID:

Go to you Ads Manager Account
Head to the drop down at the top of the screen next to the Campaigns title
Copy the Ad Account ID for the account you wish to pull data from.

If you don't supply and Ad Account ID, the extracts will by default get data from all Ad Accounts.

🚧
Tokens
Facebook authentication can expire for a number of reasons, including the following:

The user’s password changes

The user revokes permissions

If this occurs you will receive a 401 authorization error and you will have to re-authenticate the source by clicking edit -> reset.

Features

Feature	Support	Notes
Backfill	✅	3 months by default, up to 18 months (not recommended)
Incremental	✅	Incremental is supported on all reports indicated with an incrmental key bleow.
Custom backfill	❌
API reliability	🟡	See callout below

❗️
Async Errors
The Facebook API sometimes returns an Async error, see below. We handle these errors by retrying 5 times. if this error still occurs then please retry the extract.
This error is more likely to occur with larger data volumes.

{
  "source-type": "facebook-oauth-jumper",
  "message": "Async request for 23849864184600169 failed"
}

Reports detail

⬇️ Report	🔑 Incremental key	🔑 Primary key	📄 Link to API endpoint
Campaign	`DATE_STOP`	`CAMPAIGN_ID`, `DATE_START`, `DATE_STOP`, `BREAKDOWN`	AdInsights
Adset	`DATE_STOP`	`ADSET_ID`, `DATE_START`, `DATE_STOP`, `BREAKDOWN`	AdInsights
Ad	`DATE_STOP`	`AD_ID`, `DATE_START`, `DATE_STOP`, `BREAKDOWN`	AdInsights
Ad Creatives	`AD_DATE_STOP`	`ID`, `AD_DATE_STOP`	AdCreatives
Pages	`N/A`	`ID`	Get Pages
Page Insights	`end_time`	`ID`	Get Page Insights
Page Video Ad Breaks	`end_time`	`ID`	Video Ad Breaks
Page Custom Labels	`N/A`	`ID`	Get Page Custom Labels
Post Insights	`end_time`	`ID`	Post Insights
Post Video Ad Breaks	`end_time`	`ID`	Video Ad Breaks
Video Custom Labels	`N/A`	`ID`	Video Custom Labels
Instagram Business Discovery	`N/A`	`ID`	Business Discovery
Instagram Media Insights	`N/A`	`ID`	Media Insights
Instagram Business Account Insights	`N/A`	`ID`	Business Accout Insights

Limitations

📘
Duplicates
As data within the Facebook platform is always updating, the connector will fetch again all data from at least the last 7 days, to ensure you have the most up-to-date data in your warehouse.
This will cause duplicate entries for some days, and you will need to deduplicate, whilst keeping the rows that have the most recent _KLEENE_EXTRACT_DATE

📘
Page Video Ad Breaks report
Here in the Extract setup you have the option to give an individual page id for which to extract data or a comma separated list of ids for multiple pages.
In case you do not include ids, the extract will run through all the pages linked to the facebook account you authenticated with.
In case you want to specify ids: a page ID can either be taken from the destination table of the pages insights report or:
New Pages experience

To find your Page ID:

Log in to Facebook, then click your profile photo in the top right.

Click See all profiles, then select the Page that you want to switch into.

Click your Page's name in the left menu to go to it.

Click the About tab below your Page's cover photo, then click Page transparency.

Click See all, then click Go to Ad Library.

Find view_all_page_id= in the address bar of your browser. Your Page ID is the number immediately following this.

This is your Facebook Page ID.

📘
Instagram Media Insights
Media posted on your account prior to its conversion from a personal to a business account will not appear in report results and will be excluded