Skip to main content

Instagram Business Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Instagram Business accounts help retailers, local businesses, brands, organizations and service providers build relationships with customers on Instagram. The Instagram Business Reader is a data integration tool designed to enable seamless access to and interaction with data from Instagram Business accounts. It allows users to extract valuable insights and manage various marketing assets within the Instagram platform, including performance metrics, posts, audience data, and engagement statistics.

By leveraging this adapter, businesses can automate the flow of Instagram data into their CRM, marketing automation, and analytics systems, enabling better decision-making, targeted campaigns, and enhanced reporting capabilities.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

Custom objects

Authentication

Basic authentication

Username and password

OAuth authentication

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

Initial load

Pull-based incremental load

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

Striim TQL

Runtime

Resilience/recovery

Parallel execution

Metrics

Standard metrics

Supported authentication

The Instagram Business Reader supports connecting to Instagram using OAuth 2.0. Creating a connection requires creating an app for Instagram Business via the Facebook Graph API, obtaining the OAuth credentials, exchanging a short-lived access token for a long-lived access token and a refresh token, and retrieving your Instagram Business account ID.

To create a connection using OAuth authentication:

  1. Create an app for Instagram Business via the Facebook Graph API:

    1. Go to the Facebook developer portal.

    2. In the Developer Dashboard, click Create App and choose the appropriate app type (for example, "For Everything Else").

    3. Under the app settings, go to Products > Instagram and select Instagram Basic Display. Follow the setup instructions to enable the Instagram Business API for your app.

    4. Ensure the app has the necessary permissions for Instagram Business data.

    5. Initially, you will need to generate a short-lived access token via the Facebook OAuth flow. This will be used to request a long-lived token. See Creating an app on Facebook for the Instagram API.

  2. Obtain your OAuth credentials:

    1. In the Facebook Developer Portal, go to your app's settings and note the App ID and App Secret.

    2. Use the Facebook Graph API Explorer or your app to generate a short-lived access token. You will need to authenticate the user and get an access token that can be exchanged for a long-lived one. See the Access Tokens for Meta Technologies in the Facebook documentation.

      GET /oauth/access_token?client_id={app-id}&client_secret={app-secret}&redirect_uri={redirect-uri}&code={auth-code}
  3. Exchange the short-lived access token for a refresh token:

    1. Once you have the short-lived access token, you can exchange it for a long-lived refresh token. This token is valid for 60 days.

    2. Use the following endpoint to exchange your short-lived token:

      GET /oauth/access_token?grant_type=fb_exchange_token&client_id={app-id}&client_secret={app-secret}&fb_exchange_token={short-lived-access-token}

      The endpoint returns a long-lived access token and a refresh token.

  4. Retrieve your Instagram Business account ID:

    1. Log in to your Instagram account.

    2. Choose Profile in the menu on the left.

    3. Choose Edit Profile at the top, next to your Instagram profile picture.

    4. Under the Settings section on the left, click See more in the Accounts Center.

    5. Select the Instagram profile you want to view.

    6. In the URL, you’ll find your Instagram Business Account ID displayed after /profiles, in a numerical format. For example:

      https://accountscenter.instagram.com/profiles/[123456789012345]/?theme=dark

Supported objects

The following are the supported objects for reading from Instagram Business accounts:

  • Comments

  • Replies

  • AccountContactButtonType

  • AccountFollowType

  • AccountInsights

  • AccountMediaProductType

  • AccountTimeSeriesFollowType

  • AccountTimeSeriesMediaProductType

  • AccountTimeSeriesWithoutBreakdown

  • AccountWithoutBreakdown

  • AudienceInsights

  • IGMedia

  • InstagramBusinessProfile

  • InstagramPages

  • Media

  • MediaInsightReels

  • MediaInsights

  • MediaInsightsPost

  • MediaInsightsPostAlbum

  • MediaInsightsStory

  • OnlineFollowers

  • Pages

  • Permissions

  • Stories

Instagram Business Reader properties

Property

Type

Default value

Notes

Business account ID

String

The Instagram Business Account ID is a numerical ID that uniquely identifies your Instagram Business account within the Facebook ecosystem.

Client ID

String

Client ID of the private app registered in the Facebook app portal.

Client secret

Password

Client secret of the private app registered in the Facebook app portal.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list (Enum):

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Refresh token

Password

An OAuth 2.0 refresh token.Use the value generated while creating the token.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.