Data Dictionary

Data Dictionary

The resources available in the Facebook Ads data source include Ad Insights, Ad Accounts, Ad Sets, Ad Creatives, Ads, and Campaigns. For additional information, see the Facebook Ads Marketing API documentation.

Data Available: When configuring the Data Dictionary, one of the mandatory fields is called Data Available. You will be required to choose from this list.

  • Ad Accounts
  • Ad Sets
  • Ads
  • Campaigns
  • Insights

Primary Key:

  • For the Ad Accounts, Ad Sets, Ads, and Campaigns, the primary key is the Facebook supplied id field.
  • For the Ad Insights endpoint, Panoply creates the primary key based on the following pattern: <account_id>_<ad_id>_<adset_id>_<campaign_id>_<date_start>_<date_stop> _<__action_attribution_windows>_<__delivery>_<__breakdowns>_<__action>

Incremental Key: On your first collection, Panoply imports data based on the Historical Range you select when configuring this source. For subsequent collections, Panoply uses the following logic:

  • Ad Insights: Uses the date of the last successful collection, minus 30 calendar days.
  • Ad Accounts: There is no date field in this data, so Panoply will always pull all of the data of all available Ad Accounts, no matter which accounts were selected.
  • Ad Sets: Uses the date of the last successful collection, minus 2 calendar days.
  • Ads: Uses the date of the last successful collection, minus 2 calendar days.
  • Campaigns: Uses the date of the last successful collection, minus 2 calendar days.

Metadata

Panoply includes these metadata columns in the Ad Insights table:

  • __action_attribution_windows: Formatted as a combination of the payload values of the Click Attribution and View Attribution. Comma separated.
  • __delivery: The payload value of Delivery Breakdown.
  • __action: The payload value of Action Breakdown.
  • __breakdowns: The value from the API’s returned data of the fields assigned to the Delivery. Underscore delimited.
  • __id: The generated primary key for the Insight data based from the ID pattern.
  • __resource: INSIGHTS
  • __aggregation: DAY
  • __senttime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z
  • __updatetime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z

Panoply includes these metadata columns in the Ad Accounts table:

  • __senttime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __updatetime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __resource: AD_ACCOUNTS

Panoply includes these metadata columns in the Ad Sets table:

  • __senttime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __updatetime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __resource: ADSETS
  • __ad_creative_id:

    • Sub-table of facebook_adsets
    • This is generated because the original id field will be overwritten.

Panoply includes these metadata columns in the Ads table:

  • __senttime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __updatetime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __resource: ADS
  • __creative_id:

  • __ad_creative_id:

    • Sub-table of facebook_ads_ads
    • This is generated because the original id field will be overwritten.

Panoply includes these metadata columns in the Campaigns table:

  • __senttime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __updatetime: Formatted as a datetime, such as 2020-04-26T01:26:14.695Z.
  • __resource: CAMPAIGNS

Collected Tables

These tables include the data contained in each endpoint. These are parent tables, there may also be tables created by Panoply out of any nested data.

Note: Fields for each table are dynamic depending on the data returned by Facebook. Facebook only returns fields that is in the logged in user’s account. It is possible that there are fields listed here that might not be available for the user or fields not listed here but available to the user.

Ad Insights

Ad Accounts

Ad Sets

Ads

Campaigns

Getting started is easy! Get all your data in one place in minutes.
Try Free