Introduction
Instagram Graph API provides a consistent way for users to pull social media relevant metrics/data for end user analytics
User Storie(s)
- As a user, I would like to retrieve user profile/account data from Instagram so I can use it for end user analytics
- As a user, I would like to retrieve social interaction metrics (image, video, or album) related to the user as well as associated media objects, specify aggregation period and time range for the account metrics so that I can leverage for filter the data that I need for my end user analytics
- As a user, I would like to identify and retrieve comments and media objects associated with the user, retrieve social interaction metrics (image, video, or album) for relevant media objects, so that I can leverage for end user analytics
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
...
Instagram API requires
Configurables
...
Select all the types of data you want to import from Instagram. There are three options
...
Collecting data from Instagram
...
Configurables
This section defines properties that are configurable for this plugin.
| User Facing Name | Type | Description | Constraints |
|---|---|---|---|
| Access token | string | Access token | |
| Request Type | select |
| |
| Account ID | string | Account ID | Mandatory if Request Type = "Get Account Insights" |
| Media ID | string | Media Object ID | Mandatory if Request Type = "Get Media Insights" |
| Metrics To Pull | multi-select | Select the list of available fields to pull | The metrics dropdown will change based on the request type. See the links in the design section for the list of available metrics. The schema will change based on the fields selected by the user |
| Period | select | Aggregation period/no of days for metric | Mandatory if Request Type = "Get Account Insights" |
| From Date | string | Start date for retrieving metric details | Mandatory if Request Type = "Get Account Insights" |
| To Date | string | End date for retrieving metric details | Mandatory if Request Type = "Get Account Insights" |
Design / Implementation Tips
Metrics to pull will dynamically change based on the type of request that is selected. Output schema will depend on this selection. https://developers.facebook.com/docs/instagram-api/guides
This API reference currently supports user and media data, the following are not supported:
- Stories are not supported.
- Comments are not supported.
- Insights are not supported.
- Promoted posts containing Instagram media are not supported.
Note that there is another version of the API for Instagram available at the following link should be used for implementation and data pulls
Account Insights - Fields to Pull
https://developers.facebook.com/docs/instagram-api/reference/user/insights#metrics-periods
Media Insights - Fields to Pull
https://developers.facebook.com/docs/instagram-api/reference/media/insights