Instagram Source Provider
The Instagram Source feeds data from Personal and Business Instagram accounts supporting Media, Media Single, Hashtagged Media and User queries.
Settings
| Setting | Description | Default |
|---|---|---|
| Name | The name that will identify this source instance. | |
| Default Cache Time | The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration. | 3600 |
| Setting | Description |
|---|---|
| Account | The Instagram Account which to authenticate with. |
| Page | The Facebook Page associated with the Instagram Business account. Not applicable for Instagram Personal. |
Media Query
Fetches media from the authenticated account and resolves to a list of Media Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Type | The type of media to fetch, All, Image, or Video. | All | |
| Offset | The offset media to fetch. | 0 | ✓ |
| Limit | The maximum amount of media to fetch. | 20 | ✓ |
| Since/Until | The start and/or end datetime the fetched media will be restricted to. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Media Single Query
Fetches a single media from the authenticated account and resolves to a Media Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| ID | Unique identifier of the media to retrieve. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
If the Media is of Album Type you can fetch it media with the Multi Items query which resolves to a list of Album Media Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| ID | Unique identifier of the media to retrieve. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Hashtagged Media Query
Fetches top and recent hashtagged media from the authenticated business account and resolves to a list of Media Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Hashtag | The hashtag to query for. | ✓ | |
| Edge | Should the query look for Top Media or Recent Media hashtagged with. | Top | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Notice
Take into consideration that this query is available for Instagram Business Accounts only and that the API imposes the following limitations:
- Only returns public photos and videos.
- Will not return promoted/boosted/ads media.
- Responses will not always be in chronological order.
- Maximum of 30 unique hashtags within a 7 day period.
User Query
Fetches the user profile from the authenticated account and resolves to a User Type.
| Setting | Default | Description |
|---|---|---|
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 0 |
Notice
This query is only available for Instagram Business Accounts
Media Type
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Unique identifier of this media. | String | |
| Type | The type of this media, Album, Image, or Video. | String | |
| URL | The path to the locally cached media asset. | String | |
| Thumbnail URL | The path to the locally cached media thumbnail asset. | String | |
| Permalink | The Instagram Media URL, e.g. www.instagram.com/p/CO9O62hnpR5nkt. | String | |
| Caption | The caption content. | String | Limit |
| Hashtags | The media hashtags as a custom formated string with Separator argument. | String | |
| Created At | The time this media was created. | String | Date |
| Created By | The username of the user who created this media. | String |
| Business Only Options | Description | Type |
|---|---|---|
| Total Comments | Number of comments made one this media. | Int |
| Total Likes | Number of user that liked this media. | Int |
Album Media Type
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Unique identifier of this media. | String | |
| Type | The type of this media, Album, Image, or Video. | String | |
| URL | The path to the locally cached media asset. | String | |
| Thumbnail URL | The path to the locally cached media thumbnail asset. | String | |
| Permalink | The Instagram Media URL, e.g. www.instagram.com/p/CO9O62hnpR5nkt. | String | |
| Created At | The time this media was created. | String | Date |
| Created By | The username of the user who created this media. | String |
User Type
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Unique identifier of this user. | String | |
| Name | The name of this user. | String | |
| Website | The website of this user profile. | String | |
| Biography | The biography of this user profile. | String | Limit |
| Picture URL | The profile picture URL of this user. | String | |
| Total Followers | Number of Instagram users following this user. | Int | |
| Total Follows | Number of Instagram users this user follows. | Int | |
| Total Media | Number of Instagram Media published on this user. | Int |