Skip to main content
waffle.svg
Domo Knowledge Base

Instagram Business Partition Connector

Version 8

 

Intro

An Instagram business profile gives you access to promoted posts and Instagram ads, providing you the tools to grow your reach and engagement. It uses powerful advertising tools, so you can set up, run, and track campaigns to create deeper relationships with your business online and offline. The Domo Instagram Business Partition Connector enables you to pull the details about your Instagram media insights, user insights, users’ media, and much more. Use Domo’s Instagram Business Partition Connector to share, collaborate, and export your Instagram Business data in multiple formats. To learn more about the Instagram API, visit their page (https://developers.facebook.com/docs/instagram-api).

You connect to your Instagram Business account in the Data Center. To successfully connect to Instagram Business, you must first connect your Instagram account to a Facebook page and then grant connector access to your Facebook user. The steps for doing this are described in continuation. This topic discusses the fields and menus that are specific to the Instagram Business Partition connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Why should I use the Instagram Business Partition connector?

The Instagram Business Partition connector allows you to do an initial pull of historical data, known as Backfill, from Instagram Business once and then update only the most recent data on subsequent runs. This differs from the regular connector, which requires you to either replace the entire dataset everyday to get the most up to date information, or appends duplicate rows to the dataset.

Configuring the connector to backfill your data

Configuring the connector for initial run

The Backfill field in the connector determines how much historical data prior to the value in the End date field to bring into the dataset on the first run of the connector.

Example: If the End Date field is set to March 30th 2021 on the initial run of the connector, and the Backfill Days is set to 10, the connector will bring in data between March 20th 2021 and March 30th 2021 on the initial run.

Configuring the connector for subsequent runs

After the initial run, the connector will only request a limited amount of data from the provider on subsequent runs. You can configure the connector to update rows that have already been added to the dataset as well as new rows, or just add new rows. To configure the connector for subsequent runs, use the Start Date and End Date fields to describe the date range the connector should request data for.

The Start Date determines how far back the connector should request data for, and the End Date determines the last day the connector requests data for. 

Example: If the Start Date is set to 3 days ago and the End Date is set to today, then

  • On April 3rd, the connector will request data for March 31st  – April 3rd
  • On April 4th, the connector will request data for April 1st to April 4th. It will update the rows in the dataset for April 1st and April 3rd , and create a new row for April 4th.
  • On April 5th, the connector will request data from April 2nd to April 5th. It will update the rows in the dataset for April 2nd to April 4th, and create a new row for April 5th.

Replacing Backfill

At some point, you may want to refresh the entire dataset. To do so, reset the backfill. You can reset the backfill by selecting the Replace Backfill checkbox. While this checkbox is selected, the connector will run your dataset for the specified date range every time and will replace all previous data with the new data in the dataset. Note that, you need to uncheck the Replace Backfill checkbox after the first run. If you are using Append as an update method, be aware that you will lose all past history. 

Using Append vs Replace Dataset Update Modes

For best results, use the 'Append' update method with partition connectors. The 'Replace' method will only replace the data in the dataset with the data pulled in subsequent runs, and will lose historical data.

Prerequisites

To use the Instagram Business Partition connector, you need the following:

  • An Instagram Business account. You can use a standard Instagram account, and it will be converted into an Instagram Business account during the setup process.

  • A Facebook page URL that will be linked to the Instagram account. Each Facebook page can be connected to ONE Instagram Business account.

  • A Facebook administrator user account URL for the page you are linking to Instagram.

Connecting to Your Instagram Business Account

This section enumerates the options in the Credentials and Details panes in the Instagram Business Partition Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

In the Credentials pane, you connect to your Instagram Business account via Facebook. This can only be done once you have 1) connected Instagram to a Facebook page, and 2) enabled access for your Facebook user. Steps for accomplishing these tasks are provided in continuation.

Once you have connected to Instagram Business through Facebook, you can use the same account any time you go to create a new Instagram Business Partition DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Connecting Instagram to Facebook

To connect your Facebook page to Instagram, follow these instructions:

  1. Log into Facebook and navigate to the page you want to connect to Instagram.

  2. Click on Settings in the top right corner.

    instagram_biz_1.png

  3. In the Settings screen, select Instagram in the list on the left, then click Log In in the Manage Instagram on Facebook pane.

    instagram_biz_2.png
  4. In the Instagram login screen, enter the username and password of the Instagram account you want to connect to Facebook.
    If the Instagram account is not a business account, you are prompted to switch to a Business profile, as shown here:

    instagram_biz_4.png

  5. (Conditional) If the preceding dialog appears, click Continue, then click Done.

Once linking is complete, you will see your Instagram profile's business information in your Facebook page's settings.

instagram_biz_6.png

Enabling Your Facebook User

Once you have linked your Instagram account to a Facebook Page, you must ask Domo to enable your Facebook user to have access to the Connector. This can be done by contacting Domo Support and asking for access. You will need to provide the following information:

  • The URL of your company Domo instance (e.g. mycompany.domo.com)

  • Your Facebook username. This must be the username of the user who will be using the connector. This is not the name of the Page or Instagram account. You can find your username in the Facebook URL when you go to your Facebook profile:

    instagram_biz_7.png

  • Once your user has been enabled (which can take up to 5 business days,) you will need to accept the invitation in your Facebook notifications.

    Note: The notification may not be visible in the mobile app and we recommend checking on a desktop.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the Instagram Business report you want to run. The following reports are available:

Media Insights Get insights data for an individual media object.
Other Users Get the basic metadata for Instagram pages associated with other Instagram Business Accounts.
Other Users' Media Get the media information for Instagram pages associated with other Instagram Business Accounts.
User Insights Get insights for an Instagram Business Account. This report supports date partition.
Instagram Business Account Page Select the Facebook page your Instagram Business account is linked to.
Media Type Select a media type. When selecting Story, keep in mind that media data for stories can usually be retrieved only for 24 hours after the story was created.
Media Metrics Select the metrics to include in the final report.
Media Items Select how media will be chosen for this dataset.

Media

 

Select a media item.

Note: Please select only one Media Type from above, as this field supports only one media at a time.
Start Date - Specific Select the first date in your date range using the date selector.
End Date - Specific Select the last date in your date range using the date selector.

Start Date - Relative

 

Enter the number of days back that you would like to get data from (start day). Combine with End Date to create a range of represented days.

For example, if you entered 10 for Start Date and 5 for End Date, the report would contain data for 10 days ago up until 5 days ago.

End Date - Relative

 

Enter the number of days back that you would like to get data to (end day). Combine with Start Date to create a range of represented days.

For example, if you entered 10 for Start Date and 5 for End Date, the report would contain data for 10 days ago up until 5 days ago.

Other Instagram Business Account Pages Enter a comma-separated list of Instagram page names. For example, 'domo, nike'.
Reporting Timeframe Select the timeframe for each day in the final report.
User Metric Select metrics to include in the final report.
Backfill Enter the number days to backfill the data for.

Replace Backfill

While this checkbox is selected, the dataset will retrieve data as per the dates selected and replace all the data in the dataset. If you are using Append as an update mode, be aware that you will lose all past history.

Other Panes 

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.

FAQs

What do I need to know about connecting via Facebook's OAuth?

When connecting your Instagram Business account with Domo, a Facebook OAuth process will happen. It's important to correctly configure the OAuth; otherwise, you may miss some of the data (Example: missing Instagram Business data or missing Facebook Pages in the configuration section).

Below are the basic steps for correctly configuring the OAuth.

  1. First, choose to "Add account", either from the "Create Instagram Business Connector DataSet" page or from the Accounts view of the connector. For more information about adding an account, see Managing User Account for Connectors
  2. If you've never connected Facebook to Domo before, the first screen in the Facebook OAuth will be one of the two screens below. Enter your Facebook credentials (if needed) and continue.

clipboard_e0e1403cdcdf407af62dd99ff577e3d48.png

3. Now, select the Instagram Business Accounts you want to retrieve data for.

clipboard_ecda697ddb2ecb2d204a85f76c0426489.png

4. Next, select the Facebook Pages that are connected with your Instagram Business accounts.

Note: If you only select the Facebook Pages that aren't connected with a Instagram Business account, the data will be missing. However, there is no harm in selecting extraneous Facebook Pages. This means, if you're unsure which Facebook Page is connected with which Instagram Business account, you can choose "Select All."

clipboard_e19810ce6af41ef1df065c2f475115b23.png

5. Finally, enable the permissions for Domo to receive your email address and access the profiles and posts from the Instagram account connected to your page.

clipboard_edbc26bc46e789097c8b0f6c2a021fad8.png

What version of Facebook/Instagram API does this connector use?

This connector uses version 6.0 of the Facebook API (https://graph.facebook.com/v6.0/).

Which endpoint does each report call in this connector?
Report Name Endpoint URL
Media Insights /{instagram_media_id}/insights
Other Users /{instagram_business_account_id}?fields=business_discovery.username({account_name}){user_fields}
Other Users' Media /{instagram_business_account_id}/media
User Insights /{instagram_business_account_id}/insights
What do I need to power up this connector?

To start with, you need a Facebook page, a Facebook account that has a role on that page, and an Instagram account. You then need to follow the steps to connect your Instagram account and Facebook page and the steps to enable your Facebook user to have access to the Instagram Business connector. 

What are the steps to connect my Instagram account and my Facebook page?
  • To connect your page to Instagram, follow these steps:
  • Log into Facebook and go to the page that you want to connect to Instagram.
  • Open the page’s Settings.
  • On the page’s Settings window, choose the Instagram section and press the Login button.
  • This will prompt you to log into Instagram. Enter the username/password for the Instagram account that you want to connect.
  • If your Instagram account is not currently a Business account, you can convert it to a Business account at this time.
  • When the link is complete, you will see your Instagram profile’s business information in your Facebook page’s settings.
Do I need any specific kind of Instagram account and Facebook page? Do I need the admin role?

You will be connecting the Facebook page to the Instagram account then converting the account to an Instagram Business account. You don't have to be the admin of the page but since you'll be connecting it to an Instagram Business Account, the page and account should be related in some way.

How often can the data be updated?

Most information about pages is updated every 24 hours. Selected "insight" metrics are updated roughly every 15 minutes. We recommend that you configure the datasets to run every 24 hours.

What's the difference between the Instagram Business and Instagram Business Partitions connectors?

The Instagram Business Partition connector supports Date partitioning. It also supports backfilling and replace backfilling for the User Insights report and allows to query data for any date range.