- Vasudha Gupta
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 specify aggregation period and time range for the account metrics so that I can filter the data that I need for my end user analytics
- As a user, I would like to 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
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 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