The tap-facebook-pages extractor pulls data from Facebook Pages that can then be sent to a destination using a loader.
Available Variants
- airbyte
- goes-funky (default)
- voxmedia
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-facebook-pages extractor to your
project using
:meltano add -
Configure the tap-facebook-pages
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-facebook-pages --variant voxmediameltano config tap-facebook-pages set --interactivemeltano config tap-facebook-pages testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-facebook-pages
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- state
- discover
- about
- stream-maps
- schema-flattening
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-facebook-pages settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
user_tokenpagesstart_dateinsights_lookback_monthsstream_mapsstream_map_configflattening_enabledflattening_max_depth
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-facebook-pages list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
User Token (user_token)
-
Environment variable:
TAP_FACEBOOK_PAGES_USER_TOKEN
Long-lived user access token with access to all pages.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set user_token [value]Pages (pages)
-
Environment variable:
TAP_FACEBOOK_PAGES_PAGES
An array of objects containing keys id and access_token. E.g. [{'id': 'abc', 'access_token': 'def'}]
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set pages [value]Start Date (start_date)
-
Environment variable:
TAP_FACEBOOK_PAGES_START_DATE
Start date for fetching historical data.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set start_date [value]Insights Lookback Months (insights_lookback_months)
-
Environment variable:
TAP_FACEBOOK_PAGES_INSIGHTS_LOOKBACK_MONTHS
The lookback period for fetching insights data. Defaults to 12 months, meaning that we fetch insights only for the last 12 months and for posts published within the last 12 months.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set insights_lookback_months [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_FACEBOOK_PAGES_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set stream_maps [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_FACEBOOK_PAGES_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set stream_map_config [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_FACEBOOK_PAGES_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_FACEBOOK_PAGES_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-facebook-pages set flattening_max_depth [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-71-c0c0c4){kind=icon}
-3-c0c0c4){kind=icon}
