Adding a Connection to Instagram

To add a connection to Instagram:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Instagram icon is not available, click the Add More icon to download and install the Instagram connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Instagram

Instagram supports OAuth authentication only.

This section details a selection of advanced features of the Instagram Sync App.

User Defined Views

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 .

SSL Configuration

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" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Instagram and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models entities in the Instagram API as Tables, Views, and Stored Procedures. These are defined in schema files, which are simple, text-based configuration files.

Discovering the Schemas Programmatically

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.

Instagram Connector for CData Sync Tables

Name	Description
Comments	Create, delete, and query Comments on a media object. Requires the instagram_basic and instagram_manage_comments scopes.
Replies	Query and insert replies on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Create, delete, and query Comments on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Only the select, delete, and insert operations are supported.

Select

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'

Insert

Create a comment on a media object with the following rules:

• MediaId and Text are the only available and required fields.
• The total length of the comment cannot exceed 300 characters.
• The comment cannot contain more than 4 hashtags.
• The comment cannot contain more than 1 URL.
• The comment cannot consist of all capital letters.

For example:

INSERT INTO Comments (MediaId, Text) VALUES ('1501471279105199430_5380790872', 'My comment text #instadevelopers')

Update

UPDATE is not supported.

Delete

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'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier for the comment.
Text	String	False	The text of the comment.
MediaId	String	False	The unique identifier for the media.
Created	Datetime	True	The time when the media was created.
UserId	String	True	The unique identifier for the user.
Username	String	True	The username for the user.
Likes	Int	True	The number of likes.
Hidden	Boolean	True	The boolean that shows if the comment is hidden.
InstagramBusinessAccountId	String	True	The unique identifier for the Instagram business account Id.

Query and insert replies on a media object. Requires the instagram_basic and instagram_manage_comments scopes.

Only the select and insert operations are supported.

Select

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'

Insert

Create a reply on a comment object with the following rules:

• CommentId and Text are the only available and required fields.
• The total length of the comment cannot exceed 300 characters.
• The reply cannot contain more than 4 hashtags.
• The reply cannot contain more than 1 URL.
• The reply cannot consist of all capital letters.

For example:

INSERT INTO Replies (CommentId, Text) VALUES ('1501471279105199430_5380790872', 'My reply #instadevelopers')

Update

UPDATE is not supported.

Delete

Delete is not supported.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier for the reply.
Username	String	True	The username for the user.
CommentId	String	False	The unique identifier for the comment.
Created	Datetime	True	The time when the reply was created.
UserId	String	True	The unique identifier for the user.
MediaId	String	True	The unique identifier for the associated media.
Text	String	False	The comment.
LikeCount	Int	True	The number of likes.
InstagramBusinessAccountId	String	True	The unique identifier for the Instagram business account Id.

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.

Instagram Connector for CData Sync Views

Name	Description
AccountContactButtonType	It returns the number of taps on the DIRECTION, CALLs and EMAILs button during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is contact_button_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountFollowType	The number of accounts that followed and the number of accounts that unfollowed or stopped using Instagram during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountInsights	Allows you to get insights for an Instagram business account. Requires the instagram_basic and instagram_manage_insights scopes.
AccountMediaProductType	It returns the number of POSTs and IGTVs during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesFollowType	It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesMediaProductType	It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.
AccountTimeSeriesWithoutBreakdown	It returns the metric endtime and the value. For this view, the Metric type is time_series. Requires the instagram_basic and instagram_manage_insights scopes.
AccountWithoutBreakdown	It returns the total values of the metric type in Instagram. For eg, if the metric type is impressions, it will return the number of times your posts, stories, reels, videos and live videos were on screen, including in ads. For this view, the Metric Type is total_value. Requires the instagram_basic and instagram_manage_insights scopes.
AudienceInsights	Retrieve follower insights for an Instagram business account.
IGMedia	This View Represents an Instagram Photo, Video, Story, Album, or IGTV media.
InstagramBusinessProfile	Get information about the Instagram Business account. Requires the instagram_basic scope, business_management, manage_pages .
InstagramPages	Query information about pages connected to the Facebook account. Requires the instagram_basic scope.
Media	Query media objects. Requires the instagram_basic and instagram_content_publish scopes.
MediaInsightReels	Allows you to get insights for reel media object. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsights	Allows you to get insights for an individual media object. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsPost	Allows you to get insights for an individual media object for image and video POSTs. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsPostAlbum	Allows you to get insights for an individual media object for carousel album POSTs. Requires the instagram_basic and instagram_manage_insights scopes.
MediaInsightsStory	Allows you to get insights for an individual media object for Story. Requires the instagram_basic and instagram_manage_insights scopes.
OnlineFollowers	Query Online Followers insights as hourly totals. Requires the instagram_basic and instagram_manage_insights scopes.
Pages	Get details of Pages. Requires a custom OAuth app with 'pages_read_engagement' permission or the 'Page Public Content Access' feature or the 'Page Public Metadata Access' feature.
Permissions	Query the Permissions the User has granted the current application.
Stories	Query Stories. Requires the instagram_basic and instagram_manage_insights scopes.
Tags	Query tags. Requires the instagram_basic and instagram_manage_comments scopes.

It returns the number of taps on the DIRECTION, CALLs and EMAILs button during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is contact_button_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=' operator.

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'

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. Default value is profile_links_taps. The allowed values are profile_links_taps.
DIRECTION	Int	Number of taps on Direction button.
CALL	Int	Number of taps on Calls button.
EMAIL	Int	Number of taps on Emails button.
BOOKNOW	Int	Number of taps on Book Now button.
TEXT	Int	Number of taps on Text button.
INSTANTEXPERIENCE	Int	Number of taps on Instant Experience components.
UNDEFINED	Int	Number of taps on undefined components.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

The number of accounts that followed and the number of accounts that unfollowed or stopped using Instagram during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. Default value is follows_and_unfollows. The allowed values are follows_and_unfollows, reach.
Follower	Int	The number of accounts that followed the Instagram business account
Nonfollower	Int	The number of accounts that unfollowed the Instagram business account

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

Allows you to get insights for an Instagram business account. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics given a date range. The default date range is the last 7 days.

• Impressions (accepts time periods of day, week, and days_28)
• Reach (accepts time periods of day, week, and days_28)
• FollowerCount (only accepts the day period)
• EmailContacts (only accepts the day period)
• PhoneCallClicks (only accepts the day period)
• TextMessageClicks (only accepts the day period)
• GetDirectionsClicks (only accepts the day period)
• WebsiteClicks (only accepts the day period)
• ProfileViews (only accepts the day period)

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 Impressions AND 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: Impressions, Reach, FollowerCount, EmailContacts, PhoneCallClicks, TextMessageClicks, GetDirectionsClicks, WebsiteClicks, and ProfileViews.
  

  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 Impressions, FollowerCount, EmailContacts FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND ToDateTime = '2018/01/30' AND period = 'day'

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier of the Instagram business account Id.
EndTime	Date	The most recent date this insight data is relevant for.
Impressions	Integer	Total number of times this profile has been seen.
Reach	Integer	Total number of unique accounts that have seen this profile.
FollowerCount	Integer	Total number of unique accounts following this profile.
Period	String	The period for the insight. This controls how rows will be broken up (by day, week, 28 days, or lifetime). This must always be specified.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

It returns the number of POSTs and IGTVs during the selected time period. For this view, the Metric Type is total_value and Breakdown(dimension) is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=,IN' operator.

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')

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. Default value is reach. The allowed values are reach, total_interactions, likes, comments, saves, shares.
POST	Int	Number of POSTs.
IGTV	Int	Number of IGTVs.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is follow_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=' operator.

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'

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. The supported Metric types are reach, impressions. The default metric type is reach.
EndTime	Datetime	End time.
Value	Integer	Total values of the metrics.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

It returns the metric endtime and the value. For this view, the Metric type is time_series and breakdown is media_product_type. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=' operator.

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'

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. The supported Metric types are reach, impressions. The default metric type is reach.
EndTime	Datetime	End time.
Value	Integer	Total values of the metrics.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

It returns the metric endtime and the value. For this view, the Metric type is time_series. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=' operator.

The default query returns results for the 'impressions' metric.

SELECT * FROM AccountTimeSeriesWithoutBreakdown
SELECT * FROM AccountTimeSeriesWithoutBreakdown WHERE FromDateTime='2023-06-20T00:00:00Z' AND ToDateTime='2023-07-12T00:00:00Z'

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
Metric	String	Metric Type. The supported Metric types are impressions, reach. The default metric type is impressions.
EndTime	Datetime	End time.
Value	Integer	Total values of the metrics.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

It returns the total values of the metric type in Instagram. For eg, if the metric type is impressions, it will return the number of times your posts, stories, reels, videos and live videos were on screen, including in ads. For this view, the Metric Type is total_value. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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.

• Metric supports the '=,IN' operator.

The default query returns results for the 'impressions' 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')

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
TotalValue	Int	Total values of the metrics.
Metric	String	Metric Type. The supported Metric types are impressions, accounts_engaged, replies, website_clicks, profile_views, total_interactions, reach, likes, comments, saves, shares, follows_and_unfollows, profile_links_taps. The default metric type is impressions.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

Retrieve follower insights for an Instagram business account.

Select

By default this table returns the following:

• The countries of this profile's followers.

To return any of the below demographic information about your followers:

• The gender and age distribution of this profile's followers.
• The locales of this profile's followers, by country code.
• The cities of this profile's followers.

you will need to filter on the AudienceType column:

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:

• city
• country
• gender
• age
• genderandage

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.
AudienceType	String	The type of followers breakdown. Possible values: city, country, gender, age, genderandage.
AudienceGroup	String	The breakdown value for followers.
TotalAudience	Integer	The total number of followers.
Description	String	The total number of the followers for this profile who were online during the specified period.
Timeframe	String	The earliest time for insight data to have been collected. Possible values: last_14_days, last_30_days, last_90_days, prev_month, this_month, this_week.

This View Represents an Instagram Photo, Video, Story, Album, or IGTV media.

Select

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.

• Id supports the '=' operator.

For example, the following query is processed server side:

 SELECT * FROM IGMedia WHERE Id = '1234'

Columns

Name	Type	Description
Id [KEY]	String	Media ID.
IGId	String	Instagram media ID.
Caption	String	Caption for the IGMedia.
CommentsCount	Integer	Count of comments on the media.
IsCommentEnabled	Boolean	Indicates if comments are enabled or disabled. Excludes album children.
LikeCount	Integer	Count of likes on the media.
MediaProductType	String	Surface where the media is published.
MediaType	String	Media type.
MediaUrl	String	Media URL.
Owner	String	ID of Instagram user who created the media.
PermanentURL	String	Permanent URL to the media.
ShortCode	String	Shortcode to the media.
ThumbnailUrl	String	Media thumbnail URL.
Timestamp	Datetime	ISO 8601 formatted creation date in UTC.
Username	String	Username of user who created the media.
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.

Get information about the Instagram Business account. Requires the instagram_basic scope, business_management, manage_pages .

Select

The Sync App will process all filters on this table client-side within itself.

Columns

Name	Type	Description
InstagramBusinessAccountId [KEY]	String	The unique identifier of the Instagram business account
UserName	String	The username of the person.
FullName	String	The full name of the person.
ProfilePictureUrl	String	The profile picture of the person.
Bio	String	The bio of the person.
Website	String	The website of the person.
MediaCount	Integer	The media count of the profile.
FollowsCount	Integer	The follows count of the profile.
FollowersCount	Integer	The followers count of the profile.

Query information about pages connected to the Facebook account. Requires the instagram_basic scope.

Select

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 

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the pages.
Name	String	The unique identifier for the instagram.
InstagramBusinessAccountId	String	The unique identifier for the instagram.
AccessToken	String	Access Token

Query media objects. Requires the instagram_basic and instagram_content_publish scopes.

Select

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'

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the media object.
InstagramBusinessAccountId	String	The unique identifier of the Instagram business account Id.
Username	String	The username.
MediaType	String	The type of media (image or video or reels or carousel).
MediaProductType	String	The Surface where the media is published Can be AD, FEED, STORY or REELS.
Caption	String	The caption for the media. Excludes carousel children.
CommentsCount	Integer	The number of comments.
LikesCount	Integer	The number of likes.
Mediaurl	String	The video URL of the media.
Link	String	The link of the media.
Created	Datetime	The time when the media was created.

Pseudo-Columns

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 time for media object creation.
ToDateTime	Datetime	The latest time for media object creation.

Allows you to get insights for reel media object. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

• Reach
• Comments
• Likes
• Saved
• Plays
• Shares
• TotalInteractions

The Sync App will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

• MediaInsightReels will only return the result of reels object.
• Return results for the following metrics, saved for all the reels objects: Reach, Saved, Comments, Likes, Plays, Shares and TotalInteractions.
  

       SELECT * FROM MediaInsightReels WHERE MediaId = 17905513811523370"
  
       SELECT Reach, Saved, Comments, Likes, Plays, Shares, TotalInteractions FROM MediaInsightReels WHERE MediaId = 17905513811523370 
  
      

Columns

Name	Type	Description
MediaId	String	The unique identifier of the insight.
Reach	Integer	Total number of unique accounts that have seen the media object.
Saved	Integer	Total number of unique accounts that have saved the media object.
Comments	Integer	Total number of unique accounts that have Comments on the media object.
Likes	Integer	Total number of unique accounts that have likes the media object.
Plays	Integer	Total number of unique accounts that have plays the media object.
Shares	Integer	Total number of unique accounts that have Shared the media object.
TotalInteractions	Integer	Total number of unique accounts that involved in the media object.
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.

Allows you to get insights for an individual media object. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

• Impressions
• Engagement (likes, comments, and saves, only on version < 18.0)
• TotalInteractions (likes, comments, shares, and saves, only on version >= 18.0)
• Reach
• Saved
• Videoviews (only on a video object)
• Replies (only on a story object)

The Sync App will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

• MediaInsights will return result of all media objects except reels object.
• Return results for the following metrics, saved for all the image and carousel objects: impressions, engagement, and reach.
  

  SELECT * FROM MediaInsights

• Query the MediaInsights view using a different object, for example, videos.
  

  SELECT Impressions, Engagement, Reach, Saved, VideoViews FROM MediaInsights WHERE MediaId = "1321555648546465" 

Columns

Name	Type	Description
MediaId	String	The unique identifier of the insight.
Impressions	Integer	Total number of times the media object has been seen.
TotalInteractions	Integer	Total number of likes, comments, saves, and shares on the media object.
Reach	Integer	Total number of unique accounts that have seen the media object.
Saved	Integer	Total number of unique accounts that have saved the media object.
Replies	Integer	Total number of unique accounts that have replied.
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account Id.

Allows you to get insights for an individual media object for image and video POSTs. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

• Comments
• Follows
• Likes
• ProfileActivity
• ProfileVisits
• Shares
• TotalInteractions

The Sync App will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

• Return results for the following metrics, saved for all the POSTs image and video objects: Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares and TotalInteractions.
  

       SELECT * FROM MediaInsightsPost WHERE MediaId = 17945732813652602"
  
       SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsPost WHERE MediaId = 17945732813652602 
  
      

Columns

Name	Type	Description
MediaId	String	The unique identifier of the insight.
Comments	Integer	The number of comments on your post.
Follows	Integer	The number of accounts that started following you.
Likes	Integer	The number of likes on your post.
ProfileActivity	Integer	The number of actions people take when they visit your profile after engaging with your post.
ProfileVisits	Integer	The number of times your profile was visited.
Shares	Integer	The number of shares of your post.
TotalInteractions	Integer	The number of likes, saves, comments and shares on your post minus the number of unlikes, unsaves and deleted comments.

Allows you to get insights for an individual media object for carousel album POSTs. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

• TotalInteractions

The Sync App will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself.

• Return results for the following metrics, saved for all the POSTs carousel album objects: TotalInteractions.
  

       SELECT * FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602"
  
       SELECT TotalInteractions FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602 
  
      

Columns

Name	Type	Description
MediaId	String	The unique identifier of the insight.
TotalInteractions	Integer	The number of likes, saves, comments and shares on your post minus the number of unlikes, unsaves and deleted comments.

Allows you to get insights for an individual media object for Story. Requires the instagram_basic and instagram_manage_insights scopes.

Select

You can query the following metrics using server-side processing:

• Follows
• ProfileActivity
• ProfileVisits
• Shares
• TotalInteractions
• TapsForward (only on version < 18.0)
• TapsBack (only on version < 18.0)
• Exits (only on version < 18.0)
• Navigation (only on version >= 18.0)

The Sync App will use the Instagram APIs to process filters by a MediaId and will process filters on other columns client-side within itself. Please note that following the nature of Stories on Instagram, insights and metrics related to stories expire after 24 hours.

• Return results for the following metrics, saved for all the Story objects: Follows, ProfileActivity, ProfileVisits, Shares and TotalInteractions.
  

       SELECT * FROM MediaInsightsStory WHERE MediaId = 17945732813652602"
  
       SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsStory WHERE MediaId = 17945732813652602 
  
      

Columns

Name	Type	Description
MediaId	String	The unique identifier of the insight.
Impressions	Integer	Total number of times the media object has been seen.
Reach	Integer	Total number of unique accounts that have seen the media object.
Follows	Integer	The number of accounts that started following you.
ProfileActivity	Integer	The number of actions people take when they visit your profile after engaging with your story.
ProfileVisits	Integer	The number of times your profile was visited.
Shares	Integer	The number of times your profile was visited.
TotalInteractions	Integer	The number of replies and shares for your story.
Navigation	Integer	Total number of actions taken from your story such as exits, taps forward, and taps back.

Query Online Followers insights as hourly totals. Requires the instagram_basic and instagram_manage_insights scopes.

Select

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' 

Columns

Name	Type	Description
InstagramBusinessAccountId	String	The unique identifier for the business account.
StartTime	Datetime	The start datetime of the insight.
EndTime	Datetime	The end datetime of the insight.
Onlinefollowers	Integer	The number of the online followers at the specific time.

Pseudo-Columns

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 time for insight data to have been collected.
ToDateTime	Datetime	The latest time for insight data to have been collected.

Get details of Pages. Requires a custom OAuth app with 'pages_read_engagement' permission or the 'Page Public Content Access' feature or the 'Page Public Metadata Access' feature.

Table Specific Information

Select

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.

• SearchTerms supports the '=' comparison.

For example:

SELECT * FROM Pages WHERE SearchTerms = 'facebook'

Columns

Name	Type	Description
Id [KEY]	String	The ID of the Facebook Page.
EligibleForBrandedContent	Boolean	Display whether the Facebook Page is eligible to post branded content.
IsUnclaimed	Boolean	Display whether a Facebook Page that was automatically generated has been claimed by the business it represents.
Link	String	The link to the Facebook Page.
City	String	The city where the business represented by the Facebook Page is located.
Country	String	The country where the business represented by the Facebook Page is located.
Latitude	Double	The latitude of the business represented by the Facebook Page.
Longitude	Double	The longitude of the business represented by the Facebook Page.
State	String	The state where the business represented by the Facebook Page is located.
Street	String	The street on which the business represented by the Facebook Page is located.
Zip	Integer	The postal code of the business represented by the Facebook Page.
Name	String	The name of the Facebook Page.
VerificationStatus	String	The verification status of the Facebook Page that represents a business.

Pseudo-Columns

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	The term that is to be searched.

Query the Permissions the User has granted the current application.

Select

To query the Permissions view.

SELECT * FROM Permissions

Columns

Name	Type	Description
PermissionName [KEY]	String	The name of the permission.
Status	String	The status of the requested permission.

Query Stories. Requires the instagram_basic and instagram_manage_insights scopes.

Select

The Sync App process all filters on this table client-side within itself.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the story.
InstagramBusinessAccountId	String	The unique identifier of the Instagram business account Id.

Query tags. Requires the instagram_basic and instagram_manage_comments scopes.

Select

The Sync App processes all filters on this table client-side within itself.

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the tag.
Username	String	The unique identifier for the user.
Caption	String	The caption for the tag.
ComentsCount	Int	The number of coments.
LikeCount	Int	The number of likes.
MediType	String	The type of media (image or video).
MediUrl	String	The media URL.
UserId	String	The Id of the user.
Timestamp	Datetime	Time the media was created.
InstagramBusinessAccountId	String	The unique identifier for the Instagram business account.

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.

Authentication

---

Property	Description
BusinessAccountId	The Id of a connected Instagram business account Id.
Version	The Facebook Graph API version to use.
AuthenticateAsPage	true or false to authenticate for page accesstoken as when making requests to Instagram.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

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.

Proxy

---

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

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.

Schema

---

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 .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Instagram, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining 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	The Id of a connected Instagram business account Id.
Version	The Facebook Graph API version to use.
AuthenticateAsPage	true or false to authenticate for page accesstoken as when making requests to Instagram.

The Id of a connected Instagram business account Id.

Remarks

The Id of an Instagram business account connected to a Facebook page. Set this only if you have more than one Instagram business account managed with the same Facebook account.

The Facebook Graph API version to use.

Remarks

The Facebook Graph API version to use. Generally this property does not need to be set.

true or false to authenticate for page accesstoken as when making requests to Instagram.

Remarks

true or false to authenticate for page accesstoken. The page must be managed by the authenticated user.

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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, 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.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	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.

Remarks

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

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.

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

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.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that 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.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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.

Remarks

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 .

Remarks

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 .

Remarks

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 .

Remarks

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 rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Instagram, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the maximum number of results to return from Instagram, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

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 default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. 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 defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.