Instagram

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

Prerequisites

• Meta for Developers account
• Instagram business account to your Facebook page
• Instagram Graph API to your Facebook app
• Facebook OAuth Reference
• Facebook ad account ID number (you'll use this to configure Instagram as a source in Airbyte)

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. Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If this field is blank, Airbyte will replicate all data.
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. Click Authenticate your Instagram account.
6. Log in and authorize the Instagram account.
7. Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If this field is blank, Airbyte will replicate all data.
8. Click Set up source.

Supported sync modes

The Instagram source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Deduped History

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.

• User
  • User Insights
• Media
  • Media Insights
• Stories
  • Story Insights

Rate Limiting and Performance Considerations

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

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 Type	Airbyte Type
string	string
number	number
array	array
object	object

Changelog

Version	Date	Pull Request	Subject
1.0.9	2023-07-01	27908	Fix bug when user_lifetime_insights stream returns Key Error (end_time), refactored state to use IncrementalMixin
1.0.8	2023-05-26	26767	Handle permission error for insights
1.0.7	2023-05-26	26656	Remove authSpecification from connector specification in favour of advancedAuth
1.0.6	2023-03-28	26599	Handle error for Media posted before business account conversion
1.0.5	2023-03-28	24634	Add user-friendly message for no instagram_business_accounts case
1.0.4	2023-03-15	23671	Add info about main permissions in spec and doc links in error message to navigate user
1.0.3	2023-03-14	24043	Do not emit incomplete records for user_insights stream
1.0.2	2023-03-14	24042	Test publish flow
1.0.1	2023-01-19	21602	Handle abnormally large state values
1.0.0	2022-09-23	17110	Remove custom read function and migrate to per-stream state
0.1.11	2022-09-08	16428	Fix requests metrics for Reels media product type
0.1.10	2022-09-05	16340	Update to latest version of the CDK (v0.1.81)
0.1.9	2021-09-30	6438	Annotate Oauth2 flow initialization parameters in connector specification
0.1.8	2021-08-11	5354	Added check for empty state and fixed tests
0.1.7	2021-07-19	4805	Add support for previous STATE format
0.1.6	2021-07-07	4210	Refactor connector to use CDK: - improve error handling - fix sync fail with HTTP status 400 - integrate SAT