Introduction
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 specify aggregation period and time range for the metrics so that I can filter the data for my end user analytics
- As a user, I would like to retrieve social interaction metrics (image, video, or album) relevant associated 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
Authentication
Instagram API requires
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 |
| 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" |
Metrics to Pull
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