Instagram Connector for CData Sync

Build 23.0.8868
  • Instagram
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Comments
        • Replies
      • Views
        • AccountContactButtonType
        • AccountFollowersNonfollowers
        • AccountInsights
        • AccountMediaProductType
        • AccountTimeSeriesFollowType
        • AccountTimeSeriesMediaProductType
        • AccountTimeSeriesWithoutBreakdown
        • AccountWithoutBreakdown
        • AudienceInsights
        • IGMedia
        • InstagramBusinessProfile
        • InstagramPages
        • Media
        • MediaInsightReels
        • MediaInsights
        • MediaInsightsPost
        • MediaInsightsStory
        • OnlineFollowers
        • Pages
        • Permissions
        • Stories
        • Tags
    • Connection String Options
      • Authentication
        • BusinessAccountId
        • Version
        • AuthenticateAsPage
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Instagram Connector for CData Sync

Overview

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.

Instagram Version Support

The Sync App models entities in the Instagram Graph API as relational tables.

Instagram Connector for CData Sync

Establishing a Connection

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.

Instagram Connector for CData Sync

Advanced Features

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

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

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

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Instagram Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Instagram Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

Instagram Connector for CData Sync

Data Model

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.

Instagram Connector for CData Sync

Tables

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.

Instagram Connector for CData Sync

Comments

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

Instagram Connector for CData Sync

Replies

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.

Instagram Connector for CData Sync

Views

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

Instagram Connector for CData Sync

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.

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.

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.

Instagram Connector for CData Sync

AccountFollowersNonfollowers

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.

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 'follows_and_unfollows' metric.

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

To retrieve the result for other metrics, then explicitly specify the Metric in where clause. For example:

SELECT * FROM AccountFollowersNonfollowers WHERE Metric = 'reach'
SELECT * FROM AccountFollowersNonfollowers WHERE Metric IN ('follows_and_unfollows', 'reach')

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.

Instagram Connector for CData Sync

AccountInsights

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.
ProfileViews Integer Total number of unique accounts that have viewed this profile within the specified period.
FollowerCount Integer Total number of unique accounts following this profile.
EmailContacts Integer Total number of taps on the email link in this profile.
PhoneCallClicks Integer Total number of taps on the call link in this profile.
TextMessageClicks Integer Total number of taps on the text message link in this profile.
GetDirectionsClicks Integer Total number of taps on the directions link in this profile.
Websiteclicks Integer Total number of taps on the website link in 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.

Instagram Connector for CData Sync

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.

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.

Instagram Connector for CData Sync

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.

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, website_clicks, profile_views. 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.

Instagram Connector for CData Sync

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.

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 website_clicks, profile_views. 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.

Instagram Connector for CData Sync

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.

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, website_clicks, profile_views, 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.

Instagram Connector for CData Sync

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.

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.

Instagram Connector for CData Sync

AudienceInsights

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.

Instagram Connector for CData Sync

IGMedia

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.

Instagram Connector for CData Sync

InstagramBusinessProfile

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.

Instagram Connector for CData Sync

InstagramPages

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

Instagram Connector for CData Sync

Media

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.

Instagram Connector for CData Sync

MediaInsightReels

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.

Instagram Connector for CData Sync

MediaInsights

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.
Engagement Integer Total number of likes and comments on the media object. Only available when Version< 18.0
TotalInteractions Integer Total number of likes, comments, saves, and shares on the media object. Only available when Version >= 18.0
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.
VideoViews Integer Total number of unique accounts that have viewed the video.
Replies Integer Total number of unique accounts that have replied.
InstagramBusinessAccountId String The unique identifier for the Instagram business account Id.

Instagram Connector for CData Sync

MediaInsightsPost

Allows you to get insights for an individual media object for 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 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.

Instagram Connector for CData Sync

MediaInsightsStory

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.

  • 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.
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.
TapsForward Integer Total number of unique accounts that have tapped forward. Only available when Version< 18.0.
TapsBack Integer Total number of unique accounts that have tapped backwards. Only available when Version< 18.0.
Exits Integer Total number of exits from unique accounts. Only available when Version< 18.0.
Navigation Integer Total number of actions taken from your story such as exits, taps forward, and taps back. Only available when Version >= 18.0

Instagram Connector for CData Sync

OnlineFollowers

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.

Instagram Connector for CData Sync

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.

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.

Instagram Connector for CData Sync

Permissions

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.

Instagram Connector for CData Sync

Stories

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.

Instagram Connector for CData Sync

Tags

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.

Instagram Connector for CData Sync

Connection String Options

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


PropertyDescription
BusinessAccountIdThe Id of a connected Instagram business account Id.
VersionThe Facebook Graph API version to use.
AuthenticateAsPagetrue or false to authenticate for page accesstoken as when making requests to Instagram.

OAuth


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Instagram.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Instagram Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
BusinessAccountIdThe Id of a connected Instagram business account Id.
VersionThe Facebook Graph API version to use.
AuthenticateAsPagetrue or false to authenticate for page accesstoken as when making requests to Instagram.
Instagram Connector for CData Sync

BusinessAccountId

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.

Instagram Connector for CData Sync

Version

The Facebook Graph API version to use.

Remarks

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

Instagram Connector for CData Sync

AuthenticateAsPage

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.

Instagram Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
Instagram Connector for CData Sync

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

Instagram Connector for CData Sync

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Instagram Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Instagram Connector for CData Sync

SSLServerCert

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.

Instagram Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Instagram Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.

Type Default Port Description
TUNNEL 80 When this is set, the Sync App opens a connection to Instagram and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.

Instagram Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

Instagram Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

Instagram Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Instagram Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Instagram Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Instagram Connector for CData Sync

ProxyAutoDetect

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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

Instagram Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

Instagram Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

Instagram Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Instagram Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

Instagram Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

Instagram Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Instagram Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Instagram Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Instagram Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Instagram Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Instagram Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) 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" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Instagram Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Instagram Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Instagram Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Instagram Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Instagram.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Instagram Connector for CData Sync

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Instagram Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Instagram Connector for CData Sync

Pagesize

The maximum number of results to return per page from Instagram.

Remarks

The Pagesize property affects the maximum number of results to return per page from Instagram. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

Instagram Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Instagram Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Instagram Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom 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)"
	}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8868