The tap-instagram-user extractor pulls data from Instagram User Insights that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-instagram-user extractor to your
project using
:meltano add -
Configure the tap-instagram-user
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-instagram-usermeltano config tap-instagram-user set --interactivemeltano config tap-instagram-user 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-instagram-user
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
- activate-version
- about
- stream-maps
- schema-flattening
- batch
- structured-logging
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-instagram-user 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:
access_tokenig_user_idmetricsbatch_config.encoding.compressionbatch_config.encoding.formatbatch_config.storage.prefixbatch_config.storage.rootdays_to_subtractfaker_config.localefaker_config.seedflattening_enabledflattening_max_depthflattening_max_key_lengthflattening_separatorgenerate_dates_rangemetric_typeperiodstart_datestream_map_configtimeframe
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-instagram-user 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.
Access Token (access_token)
-
Environment variable:
TAP_INSTAGRAM_USER_ACCESS_TOKEN
The client's Long-Lived Token
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set access_token [value]IG User ID (ig_user_id)
-
Environment variable:
TAP_INSTAGRAM_USER_IG_USER_ID
The professional Instagram account ID
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set ig_user_id [value]Metrics (metrics)
-
Environment variable:
TAP_INSTAGRAM_USER_METRICS
List of metrics (and their breakdowns) to extract; one stream is generated per metric/breakdown combination. Each entry may override start_date/days_to_subtract/period/timeframe/metric_type/generate_dates_range for itself; otherwise the global value above applies. Required: no default value.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set metrics [value]Batch Compression Format (batch_config.encoding.compression)
-
Environment variable:
TAP_INSTAGRAM_USER_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set batch_config encoding.compression [value]Batch Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_INSTAGRAM_USER_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set batch_config encoding.format [value]Batch Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_INSTAGRAM_USER_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set batch_config storage.prefix [value]Batch Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_INSTAGRAM_USER_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set batch_config storage.root [value]Days To Subtract (days_to_subtract)
-
Environment variable:
TAP_INSTAGRAM_USER_DAYS_TO_SUBTRACT -
Default Value:
0
Default number of already-covered days to re-extract on each run, in addition to genuinely new days (overlap window, useful because Meta insights can still be corrected after their first extraction). 0 = no re-extraction. Overridable per entry in metrics.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set days_to_subtract [value]Faker Locale (faker_config.locale)
-
Environment variable:
TAP_INSTAGRAM_USER_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set faker_config locale [value]Faker Seed (faker_config.seed)
-
Environment variable:
TAP_INSTAGRAM_USER_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set faker_config seed [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_INSTAGRAM_USER_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_INSTAGRAM_USER_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set flattening_max_depth [value]Max Key Length (flattening_max_key_length)
-
Environment variable:
TAP_INSTAGRAM_USER_FLATTENING_MAX_KEY_LENGTH
The maximum length of a flattened key.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set flattening_max_key_length [value]Flattening Separator (flattening_separator)
-
Environment variable:
TAP_INSTAGRAM_USER_FLATTENING_SEPARATOR
The separator to use when flattening keys.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set flattening_separator [value]Generate Dates Range (generate_dates_range)
-
Environment variable:
TAP_INSTAGRAM_USER_GENERATE_DATES_RANGE -
Default Value:
active
'active' (default): one API call per day (since/until = 1 day). 'inactive': a single call covering the whole since/until range (fewer API calls, but loses day-by-day granularity depending on what the API returns for the metric). Overridable per entry in metrics.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set generate_dates_range [value]Metric Type (metric_type)
-
Environment variable:
TAP_INSTAGRAM_USER_METRIC_TYPE -
Default Value:
total_value
Default metric_type parameter passed to the Meta Insights API for each metric. Overridable per entry in metrics.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set metric_type [value]Period (period)
-
Environment variable:
TAP_INSTAGRAM_USER_PERIOD -
Default Value:
day
Default granularity requested from the Meta Insights API (period parameter). Overridable per entry in metrics.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set period [value]Start Date (start_date)
-
Environment variable:
TAP_INSTAGRAM_USER_START_DATE
Default 'start_date' for all metrics on first extraction (ignored once a bookmark exists). Overridable per entry in metrics (e.g. 2026-05-01T00:00:00Z). If absent, a default value is computed automatically: the 1st of the current month minus 12 months.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set start_date [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_INSTAGRAM_USER_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-instagram-user set stream_map_config [value]Timeframe (timeframe)
-
Environment variable:
TAP_INSTAGRAM_USER_TIMEFRAME
Default optional timeframe parameter passed to the Meta Insights API. Overridable per entry in metrics.
Configure this setting directly using the following Meltano command:
meltano config tap-instagram-user set timeframe [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}
