The CData Sync App provides a straightforward way to continuously pipeline your Instagram data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Instagram connector can be used from the CData Sync application to pull data from Instagram and move it to any of the supported destinations.
The Sync App models entities in the Instagram Graph API as relational tables.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
This section details a selection of advanced features of the Instagram Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Instagram objects as an easy-to-use SQL database, using tables, views, and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Instagram account.
Commonly used tables include:
| Table | Description |
| InstagramBusinessProfile | Retrieves metadata and configuration details for an Instagram Business profile, such as username, profile picture, bio, and linked Facebook page. This view is foundational for mapping the Instagram presence of a business. |
| InstagramPages | Offers visibility into Facebook Pages linked to an Instagram Business account. This is helpful for verifying page connections and managing cross-platform presence. |
| IGMedia | Represents all media types published via an Instagram business account, including photos, videos, reels, stories, albums, and IGTV. This allows for querying and performance analysis at the media object level. |
| Media | Offers a complete overview of all media objects published on an Instagram Business or Creator account, including images, videos, and carousel posts. It is essential for retrieving metadata such as captions, media types, timestamps, and permalinks. |
| Stories | Offers a filtered view of Instagram Story content linked to a specific account. It includes metadata such as timestamps, viewer counts, and interaction metrics. This view facilitates the extraction of insights and performance analysis for temporary story posts. |
| Comments | Manages and stores Instagram comment interactions, including creating, deleting, and retrieving comments linked to media content. It includes features for moderation and analysis of user engagement. |
| Replies | Stores user-generated replies associated with Instagram media objects, including comments on posts and conversations within threads. It supports both querying existing replies and inserting new ones. |
| MediaInsights | Provides performance insights for any media object published by the account. The metrics include reach, engagement, and interactions across different content types. This view aids in developing data-driven content strategies by revealing how individual posts perform across various user segments. |
| MediaInsightsPost | Provides insights specifically for photo and video posts, while excluding stories and reels. It delivers detailed metrics such as post reach, save counts, and engagement ratios. This tool is intended for evaluating the performance of static content and traditional video posts. |
| MediaInsightsReels | Compiles performance metrics specifically for Instagram Reels. It provides detailed insights, including the number of plays, likes, comments, saves, and shares. This analysis is designed to help you examine engagement trends over time for short-form video content |
| MediaInsightsStory | Provides performance insights for Instagram Stories, analyzing metrics such as reach, exits, replies, and taps forward/backward. This perspective allows for detailed analysis of temporary content. |
| AccountInsights | Aggregates key performance metrics for an Instagram business account, including reach, engagement, and profile activity data. This summary serves as a central view for tracking account-level trends over time. |
| AudienceInsights | Analyzes comprehensive demographic and behavioral data of followers for an Instagram business account, including age, gender, location, and active times. This analysis is crucial for effectively understanding and targeting audience segments. |
| OnlineFollowers | Aggregates hourly breakdowns of when a user's Instagram followers are typically online, helping to identify the best posting times for maximum visibility and engagement. |
| AccountTimeSeriesWithoutBreakdown | Returns time-series metrics without a specific breakdown dimension, making it useful for monitoring aggregated metrics like reach over time. It includes end-time and value pairs for temporal analysis. |
| AccountTimeSeriesFollowType | Provides time-based metrics on follower changes, tracking the fluctuations of follows and unfollows over specific intervals. This view uses follow_type as a breakdown dimension and facilitates time-series analysis for identifying trends. |
| AccountTimeSeriesMediaProductType | Provides chronological data on various media types, such as Posts, Stories, IGTV, shared from an Instagram business account. It helps visualize performance trends over time by using media_product_type as a breakdown dimension and supports time-series metric evaluation. |
| AccountWithoutBreakdown | Summarizes cumulative Instagram performance metrics, including total views and engagements across various content types like posts, stories, and reels. No breakdown is provided, making it suitable for overall metric tracking. |
| AccountFollowType | Captures follower dynamics by reporting the number of new followers, unfollows, and users who deactivated accounts over a defined period. This data is aggregated under the 'follow_type' breakdown and can be used to understand audience growth trends. |
| AccountMediaProductType | Analyzes content performance by media type, including standard posts and IGTV videos, over a chosen time period. Metrics are categorized by media_product_type and offer insights into which formats enhance user engagement. |
Stored Procedures are SQL scripts that extend beyond standard CRUD operations. They accept parameters, execute functions, and manage OAuth authentication tokens.
The available System Tables provide programmatic access to schema information as well as other Sync App metadata, such as the data source's querying capabilities.
The Sync App models the data in Instagram as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Comments | Manages and stores Instagram comment interactions, including creating, deleting, and retrieving comments linked to media content. It includes features for moderation and analysis of user engagement. The required permissions are instagram_basic and instagram_manage_comments. |
| Replies | Stores user-generated replies associated with Instagram media objects, including comments on posts and conversations within threads. It supports both querying existing replies and inserting new ones. To ensure access and modification rights in the comment ecosystem, it requires the instagram_basic and instagram_manage_comments permissions. |
Manages and stores Instagram comment interactions, including creating, deleting, and retrieving comments linked to media content. It includes features for moderation and analysis of user engagement. The required permissions are instagram_basic and instagram_manage_comments.
Only the select, delete, and insert operations are supported.
The Sync App will use the Instagram APIs to filter results by MediaId and will execute other filters client-side within itself.
The following query returns all comments on all media in your account. UserId will be null if the comment is from an account that is not a business account.
SELECT * FROM Comments
To query comments for a specific media object, MediaId is required. The MediaId column supports the = operator. For example:
SELECT * FROM Comments WHERE MediaId = '1501471279105199430_5380790872'
Create a comment on a media object with the following rules:
INSERT INTO Comments (MediaId, Text) VALUES ('1501471279105199430_5380790872', 'My comment text #instadevelopers')
Id (the comment's primary key) is required. For example, the following query removes a comment either on the authenticated user's media object or authored by the authenticated user.
DELETE FROM Comments WHERE Id = '1668776136772254'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique string identifier automatically assigned to each comment. This value can be used to retrieve or reference specific comments across the platform. |
| Text | String | False |
The full text content of the comment, as written by the user. This can include emojis, mentions, hashtags, or links, depending on the user's input. |
| MediaId | String | False |
The unique identifier associated with the media item (image, video, carousel) on which the comment was made. It links the comment to its corresponding media post. |
| Created | Datetime | True |
The exact Coordinated Universal Time (UTC) timestamp indicating when the comment was created. This is useful for sorting chronologically or filtering based on time. |
| UserId | String | True |
The unique identifier of the Instagram user who authored the comment. This ID is persistent across sessions and media interactions. |
| Username | String | True |
The Instagram handle of the user who posted the comment. This is the public-facing username visible on the platform. |
| Likes | Int | True |
The total number of likes that the comment has received from other users, indicating its popularity or relevance. |
| Hidden | Boolean | True |
Indicates whether the comment is hidden from public view. A value of true means the comment has been hidden due to moderation or user action. |
| InstagramBusinessAccountId | String | True |
The unique identifier for the Instagram business account that owns the media or manages the interaction. Used to differentiate comment data across multiple business profiles. |
Stores user-generated replies associated with Instagram media objects, including comments on posts and conversations within threads. It supports both querying existing replies and inserting new ones. To ensure access and modification rights in the comment ecosystem, it requires the instagram_basic and instagram_manage_comments permissions.
Only the select and insert operations are supported.
The Sync App will process a filter on CommentId server side and will execute other filters client-side within itself.
The following query returns replies from all comments in your account. UserId will be null if the reply is from an account that is not a business account.
SELECT * FROM Replies
To query replies for a specific comment, CommentId is required. The supported operator for the CommentId column is =. For example:
SELECT * FROM Replies WHERE CommentId = '1501471279105199430_5380790872'
Create a reply on a comment object with the following rules:
INSERT INTO Replies (CommentId, Text) VALUES ('1501471279105199430_5380790872', 'My reply #instadevelopers')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique string that identifies the reply within the system, ensuring traceability and reference across operations and data models. |
| Username | String | True |
The handle or screen name of the Instagram user who posted the reply, used for display and attribution in the user interface. |
| CommentId | String | False |
A unique identifier that links this reply to the original comment it is responding to, maintaining conversational thread integrity. |
| Created | Datetime | True |
The exact timestamp, in Coordinated Universal Time (UTC), indicating when the reply was submitted on the platform. |
| UserId | String | True |
A unique string that identifies the Instagram user who authored the reply, used for authentication, permission checks, and data association. |
| MediaId | String | True |
A unique identifier referencing the media object (photo, video, reel, etc.) associated with the original comment and reply. |
| Text | String | False |
The full textual content of the reply entered by the user, which can include hashtags, mentions, and emojis. |
| LikeCount | Int | True |
The total number of likes that the reply has received, reflecting user engagement and visibility. |
| InstagramBusinessAccountId | String | True |
The unique identifier of the Instagram business account that owns or is associated with the media and interactions captured in this reply. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AccountContactButtonType | Provides detailed engagement metrics for the contact buttons (DIRECTION, CALL, EMAIL) displayed on an Instagram business profile during a specific time range. It tracks the total interactions for each type of contact button tapped, allowing for in-depth analysis using the 'contact_button_type' dimension. The permissions needed for access are Instagram_basic and Instagram_manage_insights. |
| AccountFollowType | Captures follower dynamics by reporting the number of new followers, unfollows, and users who deactivated accounts over a defined period. This data is aggregated under the 'follow_type' breakdown and can be used to understand audience growth trends. The permissions required are instagram_basic and instagram_manage_insights. |
| AccountInsights | Aggregates key performance metrics for an Instagram business account, including reach, engagement, and profile activity data. This summary serves as a central view for tracking account-level trends over time. The permissions required are instagram_basic and instagram_manage_insights. |
| AccountMediaProductType | Analyzes content performance by media type, including standard posts and IGTV videos, over a chosen time period. Metrics are categorized by media_product_type and offer insights into which formats enhance user engagement. The permissions required are instagram_basic and instagram_manage_insights permissions. |
| AccountTimeSeriesFollowType | Provides time-based metrics on follower changes, tracking the fluctuations of follows and unfollows over specific intervals. This view uses follow_type as a breakdown dimension and facilitates time-series analysis for identifying trends. The permissions required include instagram_basic and instagram_manage_insights. |
| AccountTimeSeriesMediaProductType | Provides chronological data on various media types, such as Posts, Stories, IGTV, shared from an Instagram business account. It helps visualize performance trends over time by using media_product_type as a breakdown dimension and supports time-series metric evaluation. The required scopes include instagram_basic and instagram_manage_insights. |
| AccountTimeSeriesWithoutBreakdown | Returns time-series metrics without a specific breakdown dimension, making it useful for monitoring aggregated metrics like reach over time. It includes end-time and value pairs for temporal analysis. This requires the instagram_basic and instagram_manage_insights scopes. |
| AccountWithoutBreakdown | Summarizes cumulative Instagram performance metrics, including total views and engagements across various content types like posts, stories, and reels. No breakdown is provided, making it suitable for overall metric tracking. The permissions required are instagram_basic and instagram_manage_insights. |
| AudienceInsights | Analyzes comprehensive demographic and behavioral data of followers for an Instagram business account, including age, gender, location, and active times. This analysis is crucial for effectively understanding and targeting audience segments. The permissions required are instagram_basic and instagram_manage_insights. |
| IGMedia | Represents all media types published via an Instagram business account, including photos, videos, reels, stories, albums, and IGTV. This allows for querying and performance analysis at the media object level, requiring appropriate permissions based on media access. |
| InstagramBusinessProfile | Retrieves metadata and configuration details for an Instagram Business profile, such as username, profile picture, bio, and linked Facebook page. This view is foundational for mapping the Instagram presence of a business. The required permissions are instagram_basic, business_management, and manage_pages. |
| InstagramPages | Offers visibility into Facebook Pages linked to an Instagram Business account. This is helpful for verifying page connections and managing cross-platform presence. It requires the instagram_basic scope. |
| Media | Offers a complete overview of all media objects published on an Instagram Business or Creator account, including images, videos, and carousel posts. It is essential for retrieving metadata such as captions, media types, timestamps, and permalinks. To access this information, the required permissions are instagram_basic and instagram_content_publish. |
| MediaInsights | Provides performance insights for any media object published by the account. The metrics include reach, engagement, and interactions across different content types. This view aids in developing data-driven content strategies by revealing how individual posts perform across various user segments. The permissions required for this analysis are instagram_basic and instagram_manage_insights. |
| MediaInsightsPost | Provides insights specifically for photo and video posts, while excluding stories and reels. It delivers detailed metrics such as post reach, save counts, and engagement ratios. This tool is intended for evaluating the performance of static content and traditional video posts. The required permissions for access are instagram_basic and instagram_manage_insights. |
| MediaInsightsPostAlbum | Offers comprehensive analytics for individual carousel album posts shared on Instagram. It includes metrics such as reach, engagement, and saves. To access this information, the application must have the instagram_basic and instagram_manage_insights OAuth scopes, which allow it to retrieve performance data for content posted by the user. |
| MediaInsightsReels | Compiles performance metrics specifically for Instagram Reels. It provides detailed insights, including the number of plays, likes, comments, saves, and shares. This analysis is designed to help you examine engagement trends over time for short-form video content. The required permissions for access are instagram_basic and instagram_manage_insights. |
| MediaInsightsStory | Provides performance insights for Instagram Stories, analyzing metrics such as reach, exits, replies, and taps forward/backward. This perspective allows for detailed analysis of temporary content and requires both the instagram_basic and instagram_manage_insights OAuth scopes for data access. |
| OnlineFollowers | Aggregates hourly breakdowns of when a user's Instagram followers are typically online, helping to identify the best posting times for maximum visibility and engagement. This requires the instagram_basic and instagram_manage_insights scopes to access follower activity patterns. |
| Pages | Retrieves detailed metadata about Facebook Pages that are linked to an Instagram Business account. The information includes the page name, category, verification status, and any connected Instagram profiles. To access this data, you need permissions from a custom OAuth app, including either pages_read_engagement or approval for Page Public Content Access or Page Public Metadata Access. |
| Permissions | Lists the specific permissions granted by a user to the application, such as access to media, insights, or account metadata. This information is useful for auditing user consent and ensuring that the app operates within its authorized scope. |
| Stories | Offers a filtered view of Instagram Story content linked to a specific account. It includes metadata such as timestamps, viewer counts, and interaction metrics. This view facilitates the extraction of insights and performance analysis for temporary story posts. To access this feature, both instagram_basic and instagram_manage_insights permissions are required. |
| Tags | Provides a read-only interface to access hashtags and tagged media metadata, including related posts, captions, and tagging users. This view aids in analyzing user-generated tags and community trends and requires the instagram_basic and instagram_manage_comments permissions for access. |
Provides detailed engagement metrics for the contact buttons (DIRECTION, CALL, EMAIL) displayed on an Instagram business profile during a specific time range. It tracks the total interactions for each type of contact button tapped, allowing for in-depth analysis using the 'contact_button_type' dimension. The permissions needed for access are Instagram_basic and Instagram_manage_insights.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'profile_links_taps' metric.
SELECT * FROM AccountContactButtonType SELECT * FROM AccountContactButtonType WHERE FromDateTime='2023-07-02T00:00:00Z' AND ToDateTime='2023-07-24T00:00:00Z'
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique identifier associated with the Instagram Business Account from which the insights data is retrieved. This ID is required to accurately query engagement metrics specific to a business profile. |
| Metric | String | Specifies the type of engagement metric to retrieve for contact buttons. The default metric is profile_links_taps, which reflects total interactions with all contact methods on the profile.
The allowed values are profile_links_taps. |
| DIRECTION | Int | The number of times users tapped the Direction button on the Instagram business profile, typically used to get directions to a physical business location. |
| CALL | Int | The number of times users tapped the Call button on the Instagram profile, indicating intent to place a phone call to the business. |
| Int | The number of times users tapped the Email button, showing user interest in initiating contact with the business via email directly through the profile. | |
| BOOKNOW | Int | The number of times users engaged with the Book Now button, commonly linked to booking or reservation services integrated with the Instagram business profile. |
| TEXT | Int | The number of times users tapped the Text button on the business profile, which allows users to send a text message to the business directly. |
| INSTANTEXPERIENCE | Int | The number of taps on Instant Experience components refers to full-screen, mobile-optimized experiences launched from contact actions within Instagram, which include media, interactive elements, and links. |
| UNDEFINED | Int | The number of taps on contact components that could not be categorized into any predefined button types, which can include unsupported, experimental, or custom implementations. |
| StartDate | Datetime | The starting date of when the metric is calculated for a row. |
| EndDate | Datetime | The ending date of when the metric is calculated for a row. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | Represents the start of the time window for the insights data, indicating the earliest timestamp for which interaction data is included. |
| ToDateTime | Datetime | Represents the end of the time window for the insights data, marking the most recent timestamp for collected interaction metrics. |
Captures follower dynamics by reporting the number of new followers, unfollows, and users who deactivated accounts over a defined period. This data is aggregated under the 'follow_type' breakdown and can be used to understand audience growth trends. The permissions required are instagram_basic and instagram_manage_insights.
| Name | Type | Description |
| InstagramBusinessAccountId | String | The globally unique identifier assigned to the Instagram business account, used to distinguish it from other accounts within the platform's ecosystem. |
| Metric | String | Indicates the type of account follow activity metric to be retrieved. The default setting is follows_and_unfollows, which encompasses both new followers and unfollowers during the specified date range.
The allowed values are follows_and_unfollows, reach. |
| Follower | Int | Represents the total number of new followers who began following the Instagram business account during the specified time window. |
| Nonfollower | Int | Represents the total number of users who stopped following the Instagram business account within the defined reporting period. |
| StartDate | Datetime | The starting date of when the metric is calculated for a row. |
| EndDate | Datetime | The ending date of when the metric is calculated for a row. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | Indicates the beginning of the time interval for which insight metrics should be queried. Only data collected at or after this timestamp is considered. |
| ToDateTime | Datetime | Marks the end of the time range for insight metric collection. The metrics returned will include data recorded up until this timestamp. |
Aggregates key performance metrics for an Instagram business account, including reach, engagement, and profile activity data. This summary serves as a central view for tracking account-level trends over time. The permissions required are instagram_basic and instagram_manage_insights.
You can query the following metrics given a date range. The default date range is the last 7 days.
Specify a date range with the FromDateTime and ToDateTime columns. Specify the intervals of the date range by setting the Period column in the WHERE clause. Note that you cannot use a period on a metric that does not support it. For example, you cannot use FollowerCount with period days_28 because FollowerCount only supports the day period.
The Sync App will use the Instagram APIs to process filters that refer to a date range or Id. The Sync App processes other filters client-side within itself.
The following examples show how to retrieve metrics over a given date range:
The default query returns results for the following metrics during the last seven days: Reach, FollowerCount, and Views.
SELECT * FROM AccountInsights
Filter on FromDateTime and ToDateTime to explicitly specify a different date range.
The max date range cannot be more than 30 days (2592000 s).
SELECT * FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30' AND period = 'day'
Return results over a period of 7 days.
SELECT * FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND period = 'day'
Return results from 2018/01/01 to 2018/01/08.
SELECT * FROM AccountInsights WHERE ToDateTime = '2018/01/08' AND period = 'day'
Return a custom projection on account insights for the date range from 2018/01/01 to 2018/01/08.
SELECT FollowerCount, Views FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30' AND period = 'day'
| Name | Type | Description |
| InstagramBusinessAccountId | String | The unique identifier assigned to an Instagram Business Account. This value links the insights data to a specific business entity on Instagram. |
| EndTime | Date | The final date for which insight data is relevant in the queried range. This value is not applicable when the MetricType is set to total_value. |
| Views | Integer | The total number of times your content — including Reels, posts, and Stories — has been viewed. This metric is exclusively available when using the total_value setting for MetricType. |
| Reach | Integer | The total number of distinct Instagram accounts that have seen any content associated with the business profile during the selected time frame. |
| FollowerCount | Integer | The current count of unique Instagram accounts that follow this profile. This metric is only accessible when the MetricType is set to default. |
| MetricType | String | Specifies the type of metric being used for the query. The common values include default and total_value, which determine the scope and structure of the data returned.
The allowed values are default, total_value, time_series. |
| Period | String | Defines the time aggregation used for breaking down the insight data. The valid values include day, week, 28 days, and lifetime. This field is required for all queries. |
| StartDate | Datetime | The starting date of when the metric is calculated for a row. Only available when the MetricType is set to total_value. Otherwise, use EndTime. |
| EndDate | Datetime | The ending date of when the metric is calculated for a row. Only available when the MetricType is set to total_value. Otherwise, use EndTime. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | Indicates the beginning of the time window used to retrieve the insight data. This helps determine the range over which metrics are aggregated. |
| ToDateTime | Datetime | Defines the end of the time window for retrieving insight data. This, combined with FromDateTime, establishes the complete time range for the query. |
Analyzes content performance by media type, including standard posts and IGTV videos, over a chosen time period. Metrics are categorized by media_product_type and offer insights into which formats enhance user engagement. The permissions required are instagram_basic and instagram_manage_insights permissions.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'reach' metric.
SELECT * FROM AccountMediaProductType SELECT * FROM AccountMediaProductType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
To retrieve the result for other available metric, then explicitly specify the Metric in where clause. For example:
SELECT * FROM AccountMediaProductType WHERE Metric = 'total_interactions'
SELECT * FROM AccountMediaProductType WHERE Metric = 'likes'
SELECT * FROM AccountMediaProductType WHERE Metric = 'comments'
SELECT * FROM AccountMediaProductType WHERE Metric = 'saves'
SELECT * FROM AccountMediaProductType WHERE Metric = 'shares'
SELECT * FROM AccountMediaProductType WHERE Metric IN ('total_interactions', 'likes', 'comments', 'saves', 'shares')
| Name | Type | Description |
| InstagramBusinessAccountId | String | The unique identifier associated with the Instagram business account used to retrieve media insights. This ID is essential for querying metrics across various media formats tied to the business profile. |
| Metric | String | Specifies the type of performance metric to retrieve for the business account's media content. The default metric is reach.
The allowed values are reach, total_interactions, likes, comments, saves, shares, views. |
| POST | Int | Represents the total number of standard feed posts (images or videos) published by the business account within the specified time range. |
| IGTV | Int | Represents the total number of IGTV videos published by the business account during the selected reporting period. IGTV content is long-form video hosted on the Instagram platform. |
| StartDate | Datetime | The starting date of when the metric is calculated for a row. |
| EndDate | Datetime | The ending date of when the metric is calculated for a row. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | Defines the start of the reporting window for which insights are retrieved. Only data collected on or after this timestamp will be included in the result set. |
| ToDateTime | Datetime | Defines the end of the reporting window for which insights are retrieved. Only data collected up to and including this timestamp will be considered in the output. |
Provides time-based metrics on follower changes, tracking the fluctuations of follows and unfollows over specific intervals. This view uses follow_type as a breakdown dimension and facilitates time-series analysis for identifying trends. The permissions required include instagram_basic and instagram_manage_insights.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'reach' metric.
SELECT * FROM AccountTimeSeriesFollowType SELECT * FROM AccountTimeSeriesFollowType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique string identifier representing the Instagram Business Account associated with the data. This ID is used to link insights to a specific business profile within the Instagram Graph Application Programming Interface (API). |
| Metric | String | Defines the type of engagement metric being measured. The supported values are reach and views. Reach refers to the number of unique accounts that have seen the content. Views typically represent the number of times a video has been played. |
| EndTime | Datetime | The timestamp marking the end of the data collection period for the metric. This defines the upper boundary of the time range for the reported insights. |
| Value | Integer | The total number of reach or views for the specified time period. This value quantifies overall engagement. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | The beginning of the data collection period. Insight metrics are included only if they occurred on or after this date and time. |
| ToDateTime | Datetime | The ending point of the data collection window. Insight metrics are only included if they occurred on or before this datetime value. |
Provides chronological data on various media types, such as Posts, Stories, IGTV, shared from an Instagram business account. It helps visualize performance trends over time by using media_product_type as a breakdown dimension and supports time-series metric evaluation. The required scopes include instagram_basic and instagram_manage_insights.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'reach' metric.
SELECT * FROM AccountTimeSeriesMediaProductType SELECT * FROM AccountTimeSeriesMediaProductType WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique identifier assigned to an Instagram Business Account. This ID is used to associate the retrieved time series insights with the correct account across Application Programming Interface (API) operations and data aggregations. |
| Metric | String | Describes the different types of engagement metrics being measured. The supported values are reach and views. Reach refers to the number of unique accounts that have seen the content. Views typically represent the number of times a video has been played. |
| EndTime | Datetime | Represents the endpoint of the time window for which the insight metric data was collected. This is used to define the boundary of the measurement period. |
| Value | Integer | Indicates the total value of the specified metric within the defined time frame. For example, the number of unique views accumulated up to the end time. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | The beginning of the time interval during which Instagram insight data was collected. Used to filter or slice metrics based on a defined reporting window. |
| ToDateTime | Datetime | The end of the time interval during which Instagram insight data was collected. Marks the upper boundary of the time range for data analysis and filtering. |
Returns time-series metrics without a specific breakdown dimension, making it useful for monitoring aggregated metrics like reach over time. It includes end-time and value pairs for temporal analysis. This requires the instagram_basic and instagram_manage_insights scopes.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'reach' metric.
SELECT * FROM AccountTimeSeriesWithoutBreakdown SELECT * FROM AccountTimeSeriesWithoutBreakdown WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique identifier assigned to the Instagram business account. This ID is used to retrieve account-specific insights and is required for linking Application Programming Interface (API) responses to the corresponding Instagram entity. |
| Metric | String | Specifies the type of engagement metric being measured. The supported values include reach, and views. By default, the reach metric is used. Values must be comma-separated as: reach, views. |
| EndTime | Datetime | Represents the timestamp marking the end of the reporting interval for the metrics. This value is used to define the boundary of the aggregated insight data. |
| Value | Integer | Indicates the total numeric value of the chosen metric, such as reach or views, for the specified time period. The value is computed as a cumulative count over the defined reporting duration. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | Defines the beginning of the time range for which insight data has been collected. This is a pseudo-column used for internal filtering of historical metrics. |
| ToDateTime | Datetime | Defines the end of the time range for which insight data has been collected. This is a pseudo-column used for internal filtering and aggregation of recent metric data. |
Summarizes cumulative Instagram performance metrics, including total views and engagements across various content types like posts, stories, and reels. No breakdown is provided, making it suitable for overall metric tracking. The permissions required are instagram_basic and instagram_manage_insights.
The Sync App will use the Instagram APIs to process filters that refer to a date range or InstagramBusinessAccountId and will process other filters client-side within itself.
The default query returns results for the 'reach' metric.
SELECT * FROM AccountWithoutBreakdown SELECT * FROM AccountWithoutBreakdown WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'
To retrieve the result for other available metric, then explicitly specify the Metric in where clause. For example:
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'accounts_engaged'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'replies'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'website_clicks'
SELECT * FROM AccountWithoutBreakdown WHERE Metric = 'profile_views'
SELECT * FROM AccountWithoutBreakdown WHERE Metric IN ('accounts_engaged', 'replies', 'website_clicks', 'profile_views')
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique string identifier assigned to the Instagram Business Account. This value is used to query and aggregate metrics specific to a business profile across the platform. |
| TotalValue | Int | The aggregate numeric value corresponding to the selected metric across the specified date range. This represents the total engagement or performance depending on the metric type selected. |
| Metric | String | Specifies the types of Instagram metrics available for reporting. The supported metrics include: accounts engaged, replies, website clicks, profile views, total interactions, reach, likes, comments, saves, shares, follows and unfollows, profile link taps, and views. For clarity, a space is added after each comma. The default metric is reach. |
| StartDate | Datetime | The starting date of when the metric is calculated for a row. |
| EndDate | Datetime | The ending date of when the metric is calculated for a row. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | The start timestamp defining the earliest point in time from which the insight metrics are calculated. Must be in ISO 8601 format. |
| ToDateTime | Datetime | The end timestamp defining the latest point in time for which the insight metrics are included in the calculation. Must be in ISO 8601 format. |
Analyzes comprehensive demographic and behavioral data of followers for an Instagram business account, including age, gender, location, and active times. This analysis is crucial for effectively understanding and targeting audience segments. The permissions required are instagram_basic and instagram_manage_insights.
By default this table returns the following:
SELECT * FROM AudienceInsights WHERE AudienceType='country'
SELECT * FROM AudienceInsights WHERE AudienceType IN ('city','country','genderandage')
The above query will return follower counts broken down by city, follower counts broken down by country, and follower counts broken down by gender and age.
Valid values for the AudienceType column are:
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique identifier assigned to the Instagram business account associated with the data. This ID is used to distinguish insights by account. |
| AudienceType | String | Specifies the category by which follower demographics are segmented. Supported values include: city, country, gender, age, gender and age. Each represents a different type of audience insight breakdown. |
| AudienceGroup | String | Represents the specific group within the selected AudienceType category. For example, if AudienceType is 'city', this could be 'New York'. |
| TotalAudience | Integer | Indicates the total count of Instagram users who follow the business account and match the specified AudienceType and AudienceGroup. |
| Description | String | The number of followers associated with the Instagram business profile who were actively online during the designated insight collection period. |
| Timeframe | String | Defines the reporting window for the insight data. Available values include: last_14_days, last_30_days, last_90_days, prev_month, this_month, this_week. Each denotes a distinct range of time used for aggregating the audience insights. |
Represents all media types published via an Instagram business account, including photos, videos, reels, stories, albums, and IGTV. This allows for querying and performance analysis at the media object level, requiring appropriate permissions based on media access.
The Sync App will use the Instagram API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM IGMedia WHERE Id = '1234'
| Name | Type | Description |
| Id [KEY] | String | A unique identifier assigned to the media object by the system. This ID can be used to retrieve, reference, or manipulate the media through various Application Programming Interface (API) operations. |
| IGId | String | The Instagram-specific identifier for the media object. This ID is directly used within Instagram's ecosystem for identifying media content. |
| Caption | String | The textual description or commentary provided by the user when posting the media. This can include hashtags, mentions, and other user-generated content. |
| CommentsCount | Integer | The total number of comments posted on the media. This count includes only top-level comments and not replies to comments. |
| IsCommentEnabled | Boolean | A boolean flag indicating whether users are allowed to post comments on the media. This field excludes child items in album posts. |
| LikeCount | Integer | The total number of likes that the media has received. This metric reflects the audience engagement for the content. |
| MediaProductType | String | The publishing surface or product context of the media, such as feed, story, or reel, helps differentiate where the content was shared within Instagram. |
| MediaType | String | The type of media content, such as IMAGE, VIDEO, or CAROUSEL_ALBUM. This value determines the rendering and functionality of the media object. |
| MediaUrl | String | The direct Uniform Resource Locator (URL) to the actual media content (image or video). This link can be used for display or download purposes. |
| Owner | String | The unique identifier of the Instagram user who originally published the media. This value links to the user profile associated with the content. |
| PermanentURL | String | A stable, publicly accessible URL that leads directly to the media on Instagram. This link remains constant over time. |
| ShortCode | String | A short alphanumeric code used by Instagram to create a compact link to the media. It can be appended to Instagram URLs for direct access. |
| ThumbnailUrl | String | The URL of the thumbnail image generated for the media, typically used as a preview in listings or galleries. |
| Timestamp | Datetime | The Coordinated Universal Time (UTC) timestamp of when the media was created, formatted using ISO 8601. This is useful for chronological sorting and filtering. |
| Username | String | The Instagram handle (username) of the user who posted the media. This is the publicly visible account name. |
| InstagramBusinessAccountId | String | The unique identifier assigned to the Instagram Business Account associated with the media. This is used for account-level filtering or insights. |
Retrieves metadata and configuration details for an Instagram Business profile, such as username, profile picture, bio, and linked Facebook page. This view is foundational for mapping the Instagram presence of a business. The required permissions are instagram_basic, business_management, and manage_pages.
The Sync App will process all filters on this table client-side within itself.
| Name | Type | Description |
| InstagramBusinessAccountId [KEY] | String | A system-generated unique identifier for the Instagram business account used to differentiate it from personal accounts and other business profiles. This ID is required to perform Application Programming Interface (API)-based interactions with Instagram's business features. |
| UserName | String | The publicly visible handle or username associated with the Instagram business account. This is used by other users to search for or tag the business. |
| FullName | String | The full display name associated with the Instagram business account, typically reflecting the brand or entity name. |
| ProfilePictureUrl | String | The direct Uniform Resource Locator (URL) link to the current profile image associated with the business account. This image is displayed on the account's profile and in comments or posts. |
| Bio | String | The biography or self-description section on the Instagram business profile. This is a free-form text area where businesses provide a summary of their purpose, brand message, or other relevant details. |
| Website | String | The link to the business's official website, as displayed on their Instagram profile, directs users to the specified site. |
| MediaCount | Integer | The total number of media items—such as photos, videos, and reels—that the business account has published on Instagram. |
| FollowsCount | Integer | The total number of other Instagram accounts that the business account is currently following. |
| FollowersCount | Integer | The number of Instagram users who follow the business account. This metric is a key indicator of reach and audience size. |
Offers visibility into Facebook Pages linked to an Instagram Business account. This is helpful for verifying page connections and managing cross-platform presence. It requires the instagram_basic scope.
The Sync App will process all filters client-side within itself. You can use this table to obtain the value of the BusinessAccountId connection property:
SELECT Name, InstagramBusinessAccountId FROM Pages
| Name | Type | Description |
| Id [KEY] | String | The unique identifier assigned to each Instagram page record in the dataset. This value ensures each row can be uniquely referenced and is typically sourced from the platform's internal record system. |
| Name | String | The display name of the Instagram page, typically representing the profile or brand name associated with the account. This name is visible to Instagram users and helps distinguish different pages. |
| InstagramBusinessAccountId | String | The unique identifier that links this page to its corresponding Instagram business account. This ID is critical for tracking analytics, managing assets, and making Application Programming Interface (API) calls related to business-level features. |
| AccessToken | String | A string token used to authenticate access to the Instagram Business Account's data. This access token is required for performing authorized actions via the Instagram Graph API and should be securely stored. |
Offers a complete overview of all media objects published on an Instagram Business or Creator account, including images, videos, and carousel posts. It is essential for retrieving metadata such as captions, media types, timestamps, and permalinks. To access this information, the required permissions are instagram_basic and instagram_content_publish.
The Sync App will use the Instagram APIs to process filters by Id and will process other filters client-side within itself.
The following query gets all media published by the authenticated user:
SELECT * FROM Media
To retrieve a single media object, the Id is required. The Id column supports the = operator. For example:
SELECT * FROM Media WHERE Id = '1501471279105199430_5380790872'
| Name | Type | Description |
| Id [KEY] | String | A system-generated unique identifier that distinguishes each individual media object posted by the Instagram business account. |
| InstagramBusinessAccountId | String | A globally unique identifier assigned to the Instagram business account that owns or published the media content. |
| Username | String | The handle or username of the Instagram business account that published the media. This is the public-facing account name. |
| MediaType | String | Indicates the format of the media, which can be image, video, reels, or carousel. This helps categorize the type of content for engagement analysis. |
| MediaProductType | String | Specifies the platform surface where the media was published. The possible values include AD, FEED, STORY, or REELS, representing different user experiences. |
| Caption | String | The text description or commentary included with the media post. This does not include captions from individual carousel child media items. |
| CommentsCount | Integer | The total number of comments received on the media post, providing a basic measure of user engagement and interaction. |
| LikesCount | Integer | The total number of likes the media post has received from users, reflecting its popularity or resonance. |
| Mediaurl | String | The direct Uniform Resource Locator (URL) to the video file or media asset, typically used to display or retrieve the actual content programmatically. |
| Link | String | The public-facing link to view the media post on Instagram. This URL can be shared or embedded. |
| Created | Datetime | The date and time in Coordinated Universal Time (UTC) when the media content was first published on Instagram. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | The start of the date-time range used to filter media records based on their creation timestamp. |
| ToDateTime | Datetime | The end of the date-time range used to filter media records based on their creation timestamp. |
Provides performance insights for any media object published by the account. The metrics include reach, engagement, and interactions across different content types. This view aids in developing data-driven content strategies by revealing how individual posts perform across various user segments. The permissions required for this analysis are instagram_basic and instagram_manage_insights.
You can query the following metrics using server-side processing:
SELECT * FROM MediaInsights
Query the MediaInsights view using a different object, for example, videos.
SELECT Views, Engagement, Reach, Saved FROM MediaInsights WHERE MediaId = "1321555648546465"
| Name | Type | Description |
| MediaId | String | A system-generated string that uniquely identifies the media content associated with the insight, used for data tracking and retrieval across reports and analytics systems. |
| Views | Integer | The total number of times the media object was visible to users on the Instagram platform. This metric excludes bot activity and includes multiple views by the same user. |
| TotalInteractions | Integer | The combined total of all engagement actions taken on the media object, including likes, comments, shares, and saves. This metric provides a comprehensive measure of audience interaction. |
| Reach | Integer | The total count of unique Instagram accounts that have viewed the media object at least once, indicating the breadth of the content's audience exposure. |
| Saved | Integer | The number of distinct users who saved the media object to their profile collection, signaling the perceived value or interest in revisiting the content. |
| Replies | Integer | The count of unique responses or replies submitted by users, typically applicable for Stories or Reels where direct responses are enabled. |
| InstagramBusinessAccountId | String | A unique identifier string that links the insight data to the corresponding Instagram Business Account. This is used for organizational segmentation and reporting. |
Provides insights specifically for photo and video posts, while excluding stories and reels. It delivers detailed metrics such as post reach, save counts, and engagement ratios. This tool is intended for evaluating the performance of static content and traditional video posts. The required permissions for access are instagram_basic and instagram_manage_insights.
You can query the following metrics using server-side processing:
SELECT * FROM MediaInsightsPost WHERE MediaId = 17945732813652602"
SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsPost WHERE MediaId = 17945732813652602
| Name | Type | Description |
| MediaId | String | The unique identifier assigned to each media insight record. This ID helps in tracking specific media objects across reporting and analytical workflows. |
| Comments | Integer | The total count of user-generated comments posted in response to the associated media content, representing audience engagement through direct textual feedback. |
| Follows | Integer | The number of new followers who began following the account as a direct result of interactions with this specific post, indicating its effectiveness in attracting new audiences. |
| Likes | Integer | The total number of likes received on the post, reflecting user approval or positive sentiment toward the content shared. |
| ProfileActivity | Integer | The total count of actions performed on the profile page, such as taps on contact buttons or story highlights, after a user viewed or interacted with the post. |
| ProfileVisits | Integer | The total number of times users navigated to the account's profile from the media post, indicating interest in learning more about the account or viewing additional content. |
| Shares | Integer | The number of times the media post was shared by users to others through direct messages or stories, amplifying content reach and visibility. |
| TotalInteractions | Integer | The net total of engagement actions including likes, saves, comments, and shares, adjusted by subtracting negative actions such as unlikes, unsaves, and deleted comments to reflect true interaction performance. |
| Views | Integer | The total number of times the media object has been displayed on users' screens, regardless of unique viewers, serving as a measure of total content exposure. |
Offers comprehensive analytics for individual carousel album posts shared on Instagram. It includes metrics such as reach, engagement, and saves. To access this information, the application must have the instagram_basic and instagram_manage_insights OAuth scopes, which allow it to retrieve performance data for content posted by the user.
You can query the following metrics using server-side processing:
SELECT * FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602"
SELECT TotalInteractions FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602
| Name | Type | Description |
| MediaId | String | The unique identifier assigned to each media insight record. This ID is used to link the insight data to a specific post within the album and ensures traceability across datasets. |
| TotalInteractions | Integer | The aggregate number of user engagement actions related to the album post, including likes, saves, comments, and shares. This total excludes negative actions such as unlikes, unsaves, and deleted comments to reflect net positive interaction. |
| Views | Integer | The cumulative count of how many times the album post was displayed to users. This metric includes repeated views by the same user and reflects overall visibility or exposure. |
Compiles performance metrics specifically for Instagram Reels. It provides detailed insights, including the number of plays, likes, comments, saves, and shares. This analysis is designed to help you examine engagement trends over time for short-form video content. The required permissions for access are instagram_basic and instagram_manage_insights.
You can query the following metrics using server-side processing:
SELECT * FROM MediaInsightsReels WHERE MediaId = 17905513811523370"
SELECT Reach, Saved, Comments, Likes, Views, Shares, TotalInteractions FROM MediaInsightsReels WHERE MediaId = 17905513811523370
| Name | Type | Description |
| MediaId | String | A unique string that identifies the specific Instagram media object (reel) associated with the insight record. Used as the primary reference key for analytics. |
| Reach | Integer | The total count of distinct Instagram accounts that viewed the reel at least once. This metric reflects the unique reach and exposure of the media. |
| Saved | Integer | The total count of unique Instagram accounts that bookmarked or saved the reel for later viewing is recorded. This metric indicates strong content relevance and a clear intent to revisit. |
| Comments | Integer | The total number of unique Instagram users who commented on the reel reflects user engagement. It also captures feedback through written responses. |
| Likes | Integer | The total number of unique Instagram accounts that liked the reel indicates positive sentiment. This metric also demonstrates the level of engagement from the audience. |
| Shares | Integer | The total number of unique accounts that shared the reel with others, either through direct messages or their own stories, indicates organic distribution and content amplification. |
| TotalInteractions | Integer | The total number of unique accounts that engaged with the reel through any combination of likes, comments, shares, or saves. Measures overall engagement volume. |
| Views | Integer | The total number of times the reel was viewed, regardless of whether the same user viewed it multiple times. This reflects total exposure including repeat views. |
| InstagramBusinessAccountId | String | The unique identifier of the Instagram business account that owns or published the reel. This is used to link media insights back to the originating business profile. |
Provides performance insights for Instagram Stories, analyzing metrics such as reach, exits, replies, and taps forward/backward. This perspective allows for detailed analysis of temporary content and requires both the instagram_basic and instagram_manage_insights OAuth scopes for data access.
You can query the following metrics using server-side processing:
SELECT * FROM MediaInsightsStory WHERE MediaId = 17945732813652602"
SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsStory WHERE MediaId = 17945732813652602
| Name | Type | Description |
| MediaId | String | A unique identifier representing the specific story media object for which the insight data is being collected. This ID can be used to link metrics back to the original content. |
| Views | Integer | The number of times the story was viewed across all users, counting each view regardless of whether it came from the same or different users. |
| Reach | Integer | The total count of unique Instagram accounts that viewed the story at least once. This metric helps gauge the breadth of audience exposure. |
| Follows | Integer | The number of new followers acquired as a direct result of viewing the story. This can indicate how compelling the story content was in converting viewers into followers. |
| ProfileActivity | Integer | The total number of actions users took on your profile after interacting with the story, such as visiting your profile, clicking links, or initiating messages. |
| ProfileVisits | Integer | The number of distinct visits to your Instagram profile that occurred after users viewed your story. It reflects how many viewers were motivated to explore your full profile. |
| Shares | Integer | The number of times the story content was shared by viewers through Instagram's share features. This value is currently misattributed and should not represent profile visits. |
| TotalInteractions | Integer | The aggregate count of user interactions with the story, including replies and shares. It is an indicator of how engaging the content was. |
| Navigation | Integer | The sum of navigational actions taken on the story, including exiting the story, tapping forward to the next story, or tapping back to the previous one. These behaviors reflect user engagement flow. |
Aggregates hourly breakdowns of when a user's Instagram followers are typically online, helping to identify the best posting times for maximum visibility and engagement. This requires the instagram_basic and instagram_manage_insights scopes to access follower activity patterns.
You can use the FromDateTime and ToDateTime columns to filter the results by a timeframe. The Sync App uses the Instagram API to process filters that refer to a timeframe or Id and will process other filters client-side within itself.
The default query returns results as hourly totals during the last 7 days.
SELECT * FROM OnlineFollowers
The maximum timeframe you can specify with the FromDateTime and ToDateTime columns is 30 days (2592000 s).
SELECT * FROM OnlineFollowers WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30'
| Name | Type | Description |
| InstagramBusinessAccountId | String | A unique string identifier assigned to each Instagram business account. This is used to retrieve or associate insight data with the correct business entity. |
| StartTime | Datetime | The precise timestamp indicating when the measurement period for online follower activity begins, typically used to define the lower bound of the insight window. |
| EndTime | Datetime | The exact timestamp that marks the end of the online follower activity measurement period, defining the upper limit of the analyzed time range. |
| Onlinefollowers | Integer | The recorded number of followers who were actively online during the defined insight interval. This value provides insight into follower engagement trends over time. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FromDateTime | Datetime | The earliest timestamp from which the underlying insight data is available or was first collected for this account. This is used to define the historical data boundary. |
| ToDateTime | Datetime | The most recent timestamp for which insight data has been collected for this account, indicating the most recent data available in the reporting period. |
Retrieves detailed metadata about Facebook Pages that are linked to an Instagram Business account. The information includes the page name, category, verification status, and any connected Instagram profiles. To access this data, you need permissions from a custom OAuth app, including either pages_read_engagement or approval for Page Public Content Access or Page Public Metadata Access.
For information on how to create a custom OAuth app, please see Creating a Custom OAuth App. Please refer to Instagram's latest documentation for information on how to get this view's requisite permissions for a custom OAuth app.
The Sync App will use the Instagram API to process WHERE clause conditions built with the following column and operator. The SearchTerms is required to make a request and the rest of the filter is executed client side within the Sync App.
For example:
SELECT * FROM Pages WHERE SearchTerms = 'facebook'
| Name | Type | Description |
| Id [KEY] | String | A unique identifier assigned to the Facebook Page, used to distinguish it from other pages within the platform. |
| EligibleForBrandedContent | Boolean | Indicates whether the Facebook Page has been approved and meets all criteria to publish branded content, such as sponsored posts or paid partnerships. |
| IsUnclaimed | Boolean | Specifies whether the Facebook Page was automatically generated by Facebook and has not yet been officially claimed or managed by the associated business entity. |
| Link | String | The full Uniform Resource Locator (URL) hyperlink that directs users to the Facebook Page's public profile. |
| City | String | The city name extracted from the location information provided for the business associated with the Facebook Page. |
| Country | String | The country in which the business linked to the Facebook Page is physically located, based on its registered address. |
| Latitude | Double | The geographical latitude coordinate that pinpoints the exact location of the business represented by the Facebook Page. |
| Longitude | Double | The geographical longitude coordinate that defines the east-west position of the business associated with the Facebook Page. |
| State | String | The state, province, or administrative region listed as part of the physical address of the business linked to the Facebook Page. |
| Street | String | The street address component of the physical location of the business represented on the Facebook Page, typically including building number and street name. |
| Zip | Integer | The ZIP code used for mail delivery to the listed business location on the Facebook Page. |
| Name | String | The official or display name of the Facebook Page, which typically reflects the name of the associated business, organization, or entity. |
| VerificationStatus | String | Describes the current verification status of the Facebook Page, indicating whether the page has been authenticated by Facebook as a legitimate representation of a business. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SearchTerms | String | A non-stored, computed value representing one or more keywords used to facilitate text-based searches on the Facebook Page dataset. |
Lists the specific permissions granted by a user to the application, such as access to media, insights, or account metadata. This information is useful for auditing user consent and ensuring that the app operates within its authorized scope.
To query the Permissions view.
SELECT * FROM Permissions
| Name | Type | Description |
| PermissionName [KEY] | String | The specific name of the permission being requested from the user or system, such as pages_show_list, ads_management, or instagram_basic. This field identifies the exact scope or feature access the application is attempting to obtain. |
| Status | String | Indicates the current state of the permission request, such as granted, declined, or expired. This value reflects whether the user has allowed or denied the permission or if it has been revoked. |
Offers a filtered view of Instagram Story content linked to a specific account. It includes metadata such as timestamps, viewer counts, and interaction metrics. This view facilitates the extraction of insights and performance analysis for temporary story posts. To access this feature, both instagram_basic and instagram_manage_insights permissions are required.
The Sync App process all filters on this table client-side within itself.
| Name | Type | Description |
| Id [KEY] | String | A system-generated unique identifier for each Instagram story. This value is used to distinguish one story record from another within the dataset and can be used as a primary key when performing queries or joining related tables. |
| InstagramBusinessAccountId | String | A unique string identifier that links the story to a specific Instagram business account. This ID enables traceability of story performance and ownership back to the originating business profile, and is essential for cross-referencing business-specific content across datasets. |
Provides a read-only interface to access hashtags and tagged media metadata, including related posts, captions, and tagging users. This view aids in analyzing user-generated tags and community trends and requires the instagram_basic and instagram_manage_comments permissions for access.
The Sync App processes all filters on this table client-side within itself.
| Name | Type | Description |
| Id [KEY] | String | A system-generated unique identifier that represents an individual tag record within the database. |
| Username | String | The Instagram handle of the user who created the content associated with the tag. This is used to attribute content to the correct profile. |
| Caption | String | The full text caption accompanying the media, which can include hashtags, mentions, and descriptive text entered by the user. |
| ComentsCount | Int | The total number of comments submitted by other users on the media item associated with this tag. |
| LikeCount | Int | The total number of likes received by the media item, indicating engagement and popularity among viewers. |
| MediType | String | The type of media associated with the tag can be specified, with common values such as image or video. |
| MediUrl | String | The direct Uniform Resource Locator (URL) where the media asset (image or video) can be accessed. This URL typically points to a content delivery network. |
| UserId | String | The unique identifier for the user who owns or posted the media content, used internally for relational mapping. |
| Timestamp | Datetime | The exact date and time when the media was created or posted, represented in Coordinated Universal Time (UTC) to ensure consistency across time zones. |
| InstagramBusinessAccountId | String | The unique identifier assigned to the connected Instagram business account. This links the media to a specific business entity for analytics and reporting. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Instagram.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Instagram, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Azure Active Directory.
| Name | Type | Description |
| AuthMode | String | Specifies the authentication flow used to obtain the OAuth token. The valid values include APP for server-to-server communication and WEB for user-agent-based flows involving redirection to the Instagram login page. |
| Verifier | String | The one-time verification code returned by Instagram when using the Web authentication mode. It is required to exchange the authorization grant for an access token and must be passed exactly as received from the authorization redirect. |
| Scope | String | Defines the set of permissions the application is requesting access to. Each scope grants specific access to Instagram user data or functionality, such as reading media or posting comments. |
| CallbackUrl | String | The full URL where the user is redirected after granting or denying access. This must match the redirect URI configured in your Instagram app settings and is used to receive the authorization code or error message. |
| State | String | An opaque string value used to maintain state between the request and callback. It is returned as-is to the callback URL. This field can be used for correlating requests, directing users to specific resources post-login, or preventing cross-site request forgery attacks. |
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth Access Token used to authenticate API requests with Azure Active Directory. |
| OAuthRefreshToken | String | The OAuth Refresh Token used to obtain a new access token when the current one expires. |
| ExpiresIn | String | Indicates the remaining lifetime of the access token in seconds. A value of -1 means the token does not expire. |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
| Name | Type | Description |
| CallbackUrl | String | The fully qualified redirect URI to which Instagram will send the user after authorization is complete. This must match a value configured in your app's settings, and it typically handles the authorization code or access token exchange logic. |
| Scope | String | A space-separated list of permissions or scopes being requested from the user during authorization. For OAuthGrantType='CODE', these are user-facing scopes. For OAuthGrantType='CLIENT', use 'https://graph.microsoft.com/.default' to leverage preconfigured application permissions. |
| State | String | A unique string value to maintain state between your authorization request and the response. It is useful for preventing cross-site request forgery (CSRF) attacks and identifying user sessions. |
| Name | Type | Description |
| URL | String | The generated authorization URL that users can visit in their Web browser to authenticate and provide authorization to your application. |
Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Azure Active Directory resources without requiring reauthorization from the user.
| Name | Type | Description |
| OAuthRefreshToken | String | The OAuth Refresh Token obtained during the initial authorization, used to request a new access token when the original has expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The newly issued OAuth Access Token from Azure AD, required for authenticating subsequent API requests. |
| OAuthRefreshToken | String | The updated OAuth Refresh Token that can be used to renew the access token after it expires. |
| ExpiresIn | String | The duration, in seconds, until the newly issued access token expires. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| BusinessAccountId | A unique identifier, or Id, is assigned to connect with an Instagram business account. This ID serves as a key to access and manage your account. |
| Version | Specifies the version of the Instagram Graph API. |
| AuthenticateAsPage | Specifies the authentication for page access tokens when making requests to Instagram. Respond with true or false. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Instagram. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| BusinessAccountId | A unique identifier, or Id, is assigned to connect with an Instagram business account. This ID serves as a key to access and manage your account. |
| Version | Specifies the version of the Instagram Graph API. |
| AuthenticateAsPage | Specifies the authentication for page access tokens when making requests to Instagram. Respond with true or false. |
A unique identifier, or Id, is assigned to connect with an Instagram business account. This ID serves as a key to access and manage your account.
This Id is associated with an Instagram business account linked to a specific Facebook page. Set this property if you have multiple Instagram business accounts with the same Facebook profile.
This property acts as a bridge between your Instagram profile and external applications or services.
Specifies the version of the Instagram Graph API.
The Version property is primarily used to specify the version of the Instagram Graph API that an application or service will use to access Instagrams's data. Typically, this property does not need to be set. If it is not set, the default version of the API will be used.
Specifies the authentication for page access tokens when making requests to Instagram. Respond with true or false.
Accessing a page requires proving identity. To authenticate for page access tokens, a true or false value is required. The page must be managed by the user who is authenticated.
AuthenticateAsPage is essential for securing access and ensuring that only authorized users can use it.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Instagram. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Instagram. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Instagram. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Instagram Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Instagram. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Instagram.
When processing a query, instead of requesting all of the queried data at once from Instagram, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Users WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.