Skip to main content
Skip table of contents

Instagram Business

Overview

The Instagram datasource allows Instagram Professionals — Businesses and Creators — to use your app to manage their data on Instagram. The API can be used to get metrics about Instagram Businesses and Creators.

Vendor/Partner

Facebook / Instagram

Version

v17.0

API Documentation

https://developers.facebook.com/docs/instagram-api

https://developers.facebook.com/docs/instagram-api/changelog
https://developers.facebook.com/docs/graph-api/changelog/version17.0

Sunset Date

TBD as of Oct 6, 2023

Channel(s)

Social

Refresh Time (CST)

3am, 6am / Real Time

Default backfill

500 most recent media objects

Alli Data Library

(tick) (error)

Getting Started

Required Authorization

Instagram Business requires an Ads Manager account. You can check which profiles you have access to by visiting business.facebook.com.

  1. Once you have an account with Business Manager access, click the Request Instagram Ads Access button.

  2. Next, select ad accounts from the Additional Configuration Needed section. You can select multiple ad accounts by holding down the CTRL ( on macOS X) key.

  3. Make sure to click the Next button to save your selection.

Required Authorization

Limitations

This datasource pulls insights for the most recent 500 media objects on the account. It does not pull by date and as such does not have a backfill option.

Instagram stories can only be fetched within 24 hours and they cannot be a repost, see facebook documentation for details

Define your Data

Dimensions

Name

Description

MEDIA ID

The Facebook Id

INSTAGRAM ID

The Instagram Id

POSTER

The owner of the instagram post

MEDIA TYPE

Media Type, either IMAGE, VIDEO or CAROUSEL_ALBUM

INSTAGRAM URL

The permalink to the instagram post

CAPTION

Caption of post

MEDIA URL

The Instagram URL to the actual image or video.

MEDIA POSTED DATE

The date of the instagram post

Metrics

Name

Description

FOLLOWER COUNT

Number of followers for an account

FOLLOWS COUNT

Number of users an account follows

LIKE COUNT

Number of Likes on a post

COMMENT COUNT

Number of comments on a post

ENGAGEMENT

Likes and comments only

IMPRESSIONS

Impressions on a post

REACH

Number of unique impressions

VIDEO VIEWS

Number of times an instagram post was saved

SAVED

Video Views (0 for non-videos)

CAROUSEL ALBUM ENGAGEMENT

CAROUSEL ALBUM IMPRESSIONS

CAROUSEL ALBUM REACH

CAROUSEL ALBUM SAVED

CAROUSEL ALBUM VIDEO VIEWS

STORY EXITS

STORY REPLIES

STORY TAPS FORWARD

STORY TAPS BACK

January 2024 Datasource Updates

Special section for IGTV posts:

  • IGTV posts (where permalink includes /tv/) will only have ‘impressions’,‘reach’,‘saved’,‘video_views’ metrics available

Newly added metrics:

  1. For datasources that were created before this update, these metrics will be available in the ‘Define your data’ section immediately.

    1. Only new data loads will contain the newly selected data (previous loads will not contain the newly selected data)

  • Story Navigation -> This is the total number of actions taken from your story. These are made up of metrics like exited, forward, back and next story

  • Story Swipe Forward -> Total number of swipes to see this story IG Media object’s next photo or video

  • Story Navigation -> This is the total number of actions taken from your story. These are made up of metrics like exited, forward, back and next story

  • profile_activity -> The number of actions people take when they visit your profile after engaging with your post.

    • Bio Link Clicked -> The number of times people clicked on the link in your bio after engaging with your post

    • Call -> The number of times people called after engaging with your post

    • Direction -> The number of times people requested direction after engaging with your post

    • Email -> The number of times people emailed after engaging with your post

    • Text -> The number of times people texted after engaging with your post

    • Other -> The number of times people taken other actions after engaging with your post

Video, Image and Story posts only

  • Follows -> The number of accounts that started following you

Reel posts only

  • Reels Average Watch Time (milliseconds) -> The average amount of time spent playing the reel in milliseconds

  • Reels Total View Time (milliseconds) -> The total amount of time the reel was played, including any time spent replaying the reel in milliseconds

  • Total interactions -> Number of likes, saves, comments, and shares on the reel, minus the number of unlikes, unsaves, and deleted comments. Metric in development

    • Available for all media types except IGTV

Deprecated metrics:

  1. For datasources that were created before this update, the deprecated metric names will still be used but metric values will be automatically updated to the replacement metrics below.

    1. When modifying/saving these datasources after the update for the 1st time: make sure you select the replacement metrics to ensure they will be loaded into the datasource table

    2. Only the replacement metrics will be available after the 1st save. (Previous loads’ data will still be stored in the deprecated columns)

  2. For datasources created after this updated, only the replacement metrics will be available.

  • Engagement will now be replaced by total_interactions

  • carousel_album_engagement will be replaced by total_interactions

  • carousel_album_impressions will be replaced by impressions

  • carousel_album_reach will be replaced by reach

  • carousel_album_saved will be replaced by saved

  • carousel_album_video_views will be replaced by video_views

  • Exits will be replaced by tap_exit

  • taps_forward will be replaced by tap_forward

  • taps_back will be replaced by tap_back

Deprecated dimensions, what to do:

  1. For datasources that were created before this update, timestamp will continue to work as before

  2. When modifying/saving these datasources after the update for the 1st time: make sure you select the media_posted_date dimension to ensure the datasource is saved successfully

  3. Only the replacement dimension will be available after the 1st save. (Previous loads’ data will still be stored in the deprecated columns)

  4. For datasources created after this updated, only the replacement dimension will be available.

  • Timestamp will be replaced by media_posted_date

    • This is due to our recent effort to eliminate SQL reserve keywords as column names

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.