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
- Facebook ad account ID number (you'll use this to configure Instagram as a source in Airbyte
- Instagram Graph API to your Facebook app
- Facebook Instagram OAuth Reference
Setup guide
Set up Instagram
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- On the Set up the source page, select Instagram from the Source type dropdown.
- Enter a name for the Instagram connector.
- Click Authenticate your Instagram account.
- Log in and authorize the Instagram account.
- (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.
- Click Set up source.
For Airbyte Open Source:
- Navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Instagram from the Source type dropdown.
- Enter a name for your source.
- 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.
- (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.
- Click Set up source.
Supported sync modes
The Instagram source connector supports the following sync modes:
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.
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.
Entity-Relationship Diagram (ERD)
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 |
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
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
| :------ |:-----------|:---------------------------------------------------------| :------------------------------------------------------------------------------------------------------------------------ |
| 3.1.0 | 2024-07-13 | 41937 | New metrics added for StoryInsights and MediaInsights streams. |
| 3.0.22 | 2024-07-27 | 42721 | Update dependencies |
| 3.0.21 | 2024-07-20 | 42346 | Update dependencies |
| 3.0.20 | 2024-07-13 | 41784 | Update dependencies |
| 3.0.19 | 2024-07-10 | 41586 | Update dependencies |
| 3.0.18 | 2024-07-09 | 41109 | Update dependencies |
| 3.0.17 | 2024-07-08 | 41046 | Use latest CDK version possible |
| 3.0.16 | 2024-07-06 | 40903 | Update dependencies |
| 3.0.15 | 2024-07-02 | 40569 | Migrate MediaInsights and StoryInsights to low-code |
| 3.0.14 | 2024-06-26 | 40524 | Fix Api stream when the results contain not business accounts |
| 3.0.13 | 2024-06-25 | 40456 | Update dependencies |
| 3.0.12 | 2024-06-24 | 39504 | Migrate Media, Users, UserLifeTimeInsights and Stories to low-code |
| 3.0.11 | 2024-06-22 | 40127 | Update dependencies |
| 3.0.10 | 2024-06-06 | 39303 | [autopull] Upgrade base image to v1.2.2 |
| 3.0.9 | 2024-05-21 | 38554 | Upgrade to API v19.0 |
| 3.0.8 | 2024-05-20 | 38268 | Replace AirbyteLogger with logging.Logger |
| 3.0.7 | 2024-04-19 | 36643 | Updating to 0.80.0 CDK |
| 3.0.6 | 2024-04-12 | 36643 | Schema descriptions |
| 3.0.5 | 2024-03-20 | 36314 | Unpin CDK version |
| 3.0.4 | 2024-03-07 | 35875 | Remove total_interactions from the MediaInsights queries. |
| 3.0.3 | 2024-02-12 | 35177 | Manage dependencies with Poetry |
| 3.0.2 | 2024-01-15 | 34254 | Prepare for airbyte-lib |
| 3.0.1 | 2024-01-08 | 33989 | Remove metrics from video feed |
| 3.0.0 | 2024-01-05 | 33930 | Upgrade to API v18.0 |
| 2.0.1 | 2024-01-03 | 33889 | Change requested metrics for stream media_insights |
| 2.0.0 | 2023-11-17 | 32500 | Add primary keys for UserLifetimeInsights and UserInsights; add airbyte_type to timestamp fields |
| 1.0.16 | 2023-11-17 | 32627 | Fix start_date type; fix docs |
| 1.0.15 | 2023-11-14 | 32494 | Marked start_date as optional; set max retry time to 10 minutes; add suggested streams |
| 1.0.14 | 2023-11-13 | 32423 | Capture media_product_type column in media and stories stream |
| 1.0.13 | 2023-11-10 | 32245 | Add skipping reading MediaInsights stream if an error code 10 is received |
| 1.0.12 | 2023-11-07 | 32200 | The backoff strategy has been updated to make some errors retriable |
| 1.0.11 | 2023-08-03 | 29031 | Reverted advancedAuth spec changes |
| 1.0.10 | 2023-08-01 | 28910 | Updated advancedAuth broken references |
| 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 |