Skip to main content

Instagram

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
certified
Connector Version:
3.0.10(Last updated 8 days ago)
CDK Version:
0.80.0
Sync Success Rate:
Usage Rate:

This page contains the setup guide and reference information for the Instagram source connector.

Prerequisites​

Setup Guide​

Set up the Instagram connector in Airbyte​

For Airbyte Cloud:

  1. Log in to your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Instagram from the Source type dropdown.
  4. Enter a name for your source.
  5. Click Authenticate your Instagram account.
  6. Log in and authorize the Instagram account.
  7. (Optional) Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
  8. Click Set up source.

For Airbyte Open Source:

  1. Log in to your Airbyte Open Source account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Instagram from the Source type dropdown.
  4. Enter a name for your source.
  5. Enter Access Token generated using Graph API Explorer or by using an app you can create on Facebook with the required permissions: instagram_basic, instagram_manage_insights, pages_show_list, pages_read_engagement.
  6. (Optional) Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
  7. Click Set up source.

Supported sync modes​

The Instagram source connector supports the following sync modes:

note

Incremental sync modes are only available for the User Insights stream.

Supported Streams​

The Instagram source connector supports the following streams. For more information, see the Instagram Graph API and Instagram Insights API documentation.

info

The Instagram connector syncs data related to Users, Media, and Stories and their insights from the Instagram Graph API. For performance data related to Instagram Ads, use the Facebook Marketing source.

Data type map​

AirbyteRecords are required to conform to the Airbyte type system. This means that all sources must produce schemas and records within these types and all destinations must handle records that conform to this type system.

Integration TypeAirbyte Type
stringstring
numbernumber
arrayarray
objectobject

Limitations & Troubleshooting​

Expand to see details about Instagram connector limitations and troubleshooting.

Connector limitations​

Rate limiting​

Instagram limits the number of requests that can be made at a time. See Facebook's documentation on rate limiting for more information.

Troubleshooting​

  • Check out common troubleshooting issues for the Instagram source connector on our Airbyte Forum.

Reference​

Config fields reference

Field
Type
Property name
string
access_token
string
start_date
string
client_id
string
client_secret

Changelog​

Expand to review
VersionDatePull RequestSubject
3.0.112024-07-1739303Migrate Media, Users, UserLifeTimeInsights and Stories to low-code
3.0.102024-06-0639303[autopull] Upgrade base image to v1.2.2
3.0.92024-05-2138554Upgrade to API v19.0
3.0.82024-05-2038268Replace AirbyteLogger with logging.Logger
3.0.72024-04-1936643Updating to 0.80.0 CDK
3.0.62024-04-1236643Schema descriptions
3.0.52024-03-2036314Unpin CDK version
3.0.42024-03-0735875Remove total_interactions from the MediaInsights queries.
3.0.32024-02-1235177Manage dependencies with Poetry
3.0.22024-01-1534254Prepare for airbyte-lib
3.0.12024-01-0833989Remove metrics from video feed
3.0.02024-01-0533930Upgrade to API v18.0
2.0.12024-01-0333889Change requested metrics for stream media_insights
2.0.02023-11-1732500Add primary keys for UserLifetimeInsights and UserInsights; add airbyte_type to timestamp fields
1.0.162023-11-1732627Fix start_date type; fix docs
1.0.152023-11-1432494Marked start_date as optional; set max retry time to 10 minutes; add suggested streams
1.0.142023-11-1332423Capture media_product_type column in media and stories stream
1.0.132023-11-1032245Add skipping reading MediaInsights stream if an error code 10 is received
1.0.122023-11-0732200The backoff strategy has been updated to make some errors retriable
1.0.112023-08-0329031Reverted advancedAuth spec changes
1.0.102023-08-0128910Updated advancedAuth broken references
1.0.92023-07-0127908Fix bug when user_lifetime_insights stream returns Key Error (end_time), refactored state to use IncrementalMixin
1.0.82023-05-2626767Handle permission error for insights
1.0.72023-05-2626656Remove authSpecification from connector specification in favour of advancedAuth
1.0.62023-03-2826599Handle error for Media posted before business account conversion
1.0.52023-03-2824634Add user-friendly message for no instagram_business_accounts case
1.0.42023-03-1523671Add info about main permissions in spec and doc links in error message to navigate user
1.0.32023-03-1424043Do not emit incomplete records for user_insights stream
1.0.22023-03-1424042Test publish flow
1.0.12023-01-1921602Handle abnormally large state values
1.0.02022-09-2317110Remove custom read function and migrate to per-stream state
0.1.112022-09-0816428Fix requests metrics for Reels media product type
0.1.102022-09-0516340Update to latest version of the CDK (v0.1.81)
0.1.92021-09-306438Annotate Oauth2 flow initialization parameters in connector specification
0.1.82021-08-115354Added check for empty state and fixed tests
0.1.72021-07-194805Add support for previous STATE format
0.1.62021-07-074210Refactor connector to use CDK: - improve error handling - fix sync fail with HTTP status 400 - integrate SAT
Was this page helpful?