Instagram Integration Documentation
Overview
The Instagram integration in the Vantage analytics and data platform allows users to connect their Instagram accounts via the Instagram Business API, which is accessed through the Facebook Graph API. This integration enables businesses to gather insights on their Instagram performance, track engagements, and analyze data to improve their social media strategies.
Settings
This section outlines the various settings available for the Instagram integration, detailing their purpose, input types, default values, and effects on the integration's functionality.
Settings Breakdown
-
Project ID
- Input Type: String
- Description: This is a unique identifier for the project within the Vantage platform. It helps to associate the integration with the correct configuration and data sets.
- Default Value: None (mandatory field)
- Effect of Change: If changed, the integration may fail to associate with the correct data sources or may lead to data discrepancies.
-
Access Token
- Input Type: String
- Description: A token required for authenticating the Instagram API requests. It represents the account's permission to access Instagram Business data.
- Default Value: None (mandatory field)
- Effect of Change: Altering this token without updating permissions can cause authorization failures, leading to inability to retrieve data.
-
Data Fetch Interval
- Input Type: Numeric (in minutes)
- Description: Specifies how often data should be fetched from Instagram. This can help in real-time monitoring or periodic reporting.
- Default Value: 30 minutes
- Effect of Change: Decreasing the interval allows for more frequent data updates but may increase API call costs and impact performance. Increasing it can lead to outdated data.
-
Scope of Data
- Input Type: Dropdown (options:
Insights,Content,Engagement) - Description: Defines what type of data is fetched from the API.
- Default Value:
Insights - Effect of Change: Changing the selection determines what category of data metrics will be available. For example, switching to
Engagementwill focus on likes, comments, and shares instead of overall account insights.
- Input Type: Dropdown (options:
-
Enable Webhooks
- Input Type: Boolean
- Description: Option to enable real-time updates via webhooks from Instagram (if supported).
- Default Value: False
- Effect of Change: Enabling this setting allows for immediate updates when events occur (like a new comment), making it essential for real-time analytics.
How It Works
The integration operates by utilizing the MetaIntegration class, which provides a standardized method of accessing the Facebook Graph API to retrieve Instagram data. When configuring the Instagram integration, the specified settings are passed to the BuildConnectionInstance() method, which resolves to the defined integration class. This ensures that data fetching and processing align with the user’s requirements.
- Initialization: The integration is initialized with configurations defined in the settings section.
- Authentication: When the access token is provided, the system verifies access rights to the Instagram account.
- Data Retrieval: Based on the specified fetch interval and scope, data is collected at regular intervals:
- For example, if
Insightsis selected, metrics such as reach, impressions, and profile visits will be aggregated.
- For example, if
- Handling Webhooks: If webhooks are enabled, the integration listens for any real-time updates on selected events, allowing for immediate data reflection in the analytics dashboard.
Use Cases & Examples
Use Case 1: Performance Tracking
Businesses can track the effectiveness of their posts by analyzing engagement metrics. This aids in determining which content resonates most with their audience.
Use Case 2: Social Media Campaign Monitoring
During a promotional campaign, marketing teams can assess the campaign's reach and engagement levels in real-time to adjust strategies on the fly.
Use Case 3: Competitive Analysis
With the integration, companies can benchmark their performance against industry standards by analyzing comparative data sets.
Example Configuration for Use Case 1
Scenario: A marketing team wants to track the engagement of their recent Instagram posts over a period of time.
Sample Configuration Data:
{
"Project ID": "sample-project-123",
"Access Token": "EAA...xyz",
"Data Fetch Interval": 15,
"Scope of Data": "Engagement",
"Enable Webhooks": true
}Explanation:
- The project ID connects their analytics project.
- The access token ensures that the system can retrieve data from the designated Instagram account.
- A 15-minute fetch interval allows for near real-time engagement tracking.
- By selecting
Engagement, the team will focus solely on likes, comments, and interactions, which is vital for assessing post performance. - Enabling webhooks allows immediate updates on new interactions, facilitating quicker responses and insights.
This configuration ensures comprehensive monitoring of Instagram engagement, enabling better decision-making based on live data.