Facebook Connector for CData Sync

Build 24.0.9175
  • Facebook
    • Establishing a Connection
      • Working With Insights
        • Insight Mapping Reference
      • Datamodel Permissions
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Likes
        • Posts
      • Views
        • Comments
        • Events
        • InsightsByConsumptionType
        • InsightsByFeedbackType
        • InsightsByLikeSourceType
        • InsightsByReactionTotals
        • InsightsByStoryType
        • InsightsByTabType
        • InsightsByUnLikeSourceType
        • InstagramAccountInsights
        • PageAndPostInsights
        • PageLiveVideos
        • Pages
        • Permissions
        • Photos
        • Places
        • PostSponsorTags
        • Ratings
        • SimpleVideoInsights
        • StoryAttachments
        • TaggedBy
        • Users
        • VideoInsightsByActionType
        • VideoInsightsByDistributionType
        • VideoInsightsByReactionType
        • VideoReels
        • Videos
        • Wall
    • Connection String Options
      • Authentication
        • AuthenticateAsPage
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • 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
        • AggregateFormat
        • IgnorePermissionErrors
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Target
        • Timeout
        • UploadLinkedMedia
        • UserDefinedViews

Facebook Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Facebook data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Facebook connector can be used from the CData Sync application to pull data from Facebook and move it to any of the supported destinations.

Facebook Version Support

By default, the Sync App models the current version of the Facebook Graph API, as bidirectional tables.

Facebook Connector for CData Sync

Establishing a Connection

Adding a Connection to Facebook

To add a connection to Facebook:

  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 Facebook icon is not available, click the Add More icon to download and install the Facebook 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 Facebook

Before you can connect to Facebook, you must obtain the appropriate connection properties. Since Facebook supports user authentication only via OAuth, you must either use the CData-supplied embedded OAuth application or create a custom OAuth application, as described in Creating a Custom OAuth Application.

You can also set the following optional connection properties:

  • Target: This property enables you to filter the results of all queries in the connection to records that match a specified target. For example, to retrieve comments on a video, specify the Id of the video as the target. To specify this restriction per query, use the table's Target column.
  • AggregateFormat: This property enables you to return aggregate columns as XML data rather than JSON (the default format).

Authenticating to Facebook

The following subsections describe how to authenticate to Facebook from any available OAuth access flow. For information about creating a custom OAuth application, see Creating a Custom OAuth Application.

Web Applications

When connecting via a Web application, you must create and register a custom OAuth application with Facebook, as described in Creating a Custom OAuth Application. You can then use the Sync App to get and manage the OAuth token values.

Get an OAuth Access Token

To obtain the OAuthAccessToken set the following connection properties:

  • OAuthClientId: Set to the client Id in your application settings.
  • OAuthClientSecret: Set to the client secret in your application settings
  • Scope (optional): Set only if you need to customizie the permissions that the driver requests.
  • AuthenticateAsPage (optional): Set to a page Id to make requests as a page. The page must be managed by the authenticated user.

Now call stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. If necessary, set the "Scope" parameter to request custom permissions.
  2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the "Scope" parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

Creating a custom OAuth app is optional in the headless OAuth flow; if you want to skip creating an app, you can connect with the driver's embedded OAuth credentials. However, you might want to create a custom OAuth app to change the information displayed when users log into Facebook to grant permissions to the driver. For information on how to create a custom OAuth application, see Creating a Custom OAuth Application.

  1. Choose one of these two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code", below.
    • Option 2: Install the Sync App on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings", below.
  2. Configure the Sync App to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. If you are using the Embedded OAuth Application:
    1. Call the GetOAuthAuthorizationURL stored procedure.
    2. Click Facebook OAuth endpoint to open the endpoint in your browser.
  2. If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
    • InitiateOAuth: Set to OFF.
    • OAuthClientId: Set to the client Id assigned when you registered your application.
    • OAuthClientSecret: Set to the client secret assigned when you registered your application.
  3. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURI input parameter set to the exact Redirect URI you specified in your application settings.
  4. Open the URL returned by the stored procedure in a browser.
  5. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
  6. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthClientId: Set to the Client ID in your OAuth Integration settings.
  • OAuthClientSecret: Set to the Client Secret in your OAuth Integration settings.
  • OAuthVerifier: Set to the verifier code.
  • OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified location.
  • InitiateOAuth: Set to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set to REFRESH.

Option 2: Transfer OAuth Settings

To install the Sync App on another machine, authenticate, and then transfer the resulting OAuth values:

  1. On a second machine, install the Sync App and connect with the following properties set:
    • OAuthSettingsLocation: Set to a writable location.
    • OAuthClientId: Set to the client ID in your app settings.
    • OAuthClientSecret: Set to the client secret in your app settings.
    • CallbackURL: Set to the callback URL in your app settings.
  2. Test the connection to authenticate. The resulting authentication values are written and encrypted to the path specified by OAuthSettingsLocation. After you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
    • InitiateOAuth: Set to REFRESH.
    • OAuthSettingsLocation: Set to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you must generate a new OAuth access token with the required permissions. Set the Scope property in the authentication step. You can find a list of available Facebook permissions here:

http://developers.facebook.com/docs/authentication/permissions/

Permissions that may be required depending on your use case are:

user_birthday, user_photos, user_videos, user_likes, user_hometown, user_location, read_insights, pages_manage_metadata, pages_read_engagement, pages_read_user_content, pages_messaging, business_management, instagram_basic, instagram_manage_insights

Note that in some cases, permissions restrictions might not be due to missing but requestable Facebook OAuth permissions, but instead might be due to missing OAuth app features, like Page Public Content Access or Page Public Metadata Access. These features are tied to the OAuth app as a whole, and cannot be approved or denied for individual OAuth access tokens requested by users. Consider Creating a Custom OAuth Application if you need access to app features not available with the embedded OAuth app.

AuthenticateAsPage Property

Use the AuthenticateAsPage connection property if you want to post as a single page. To query collections of pages, leave AuthenticateAsPage blank, in which case CData tools automatically detect which page tokens to use.

The following sections compare the two options.

Posting as a Page

After authenticating to Facebook with your user account, you can post, etc. as one of the pages you manage: Set the AuthenticateAsPage property to the Id of the page you want. You can find the Ids for all pages your account has access to by querying the Pages view.

Automatic Page

Facebook has made a number of recent changes that require page tokens for most resources owned by a page. This can be troublesome if you manage multiple pages and want to execute the same queries across all pages (such as retrieving Insights). In order to make this work seamlessly with our tools, we have added a way to automatically detect the page token to use. For this to work, simply do not specify the AuthenticateAsPage. Note that the correct page token can only be resolved if the page id is specified as part of the target in the request. This means for some requests you will still need to manually specify AuthenticateAsPage.

Facebook Connector for CData Sync

Working With Insights

Facebook Insights enables you to search and analyze data about how users are interacting with your Facebook page. Metrics are displayed in read-ony tables called views.

Views are comprised of columns and pseudo-columns. Like tables, they display data in columns and rows, and you can execute a query against a view to refine its results further. (The query will return another read-only table). However, because views are read-only you cannot interact with the data itself unless there is a stored procedure available to modify the data source.

Available views include:

View Name Description
InsightsByConsumptionType Retrieves insights sorted by how users consumed your content; for example, playing a video, viewing a photo, or clicking a link.
InsightsByFeedbackType Retrieves insights sorted by feedback type, such as likes or comments.
InsightsByLikeSourceType Retrieves insights sorted by source type; for example, ads, news feedk or page suggestions.
InsightsByReactionTotals Shows reactions to your page sorted by type; for exanple, like, love, wow, haha, sorry, or anger.
InsightsByStoryType Sorts insights by story type, such as user post, page post, checkin, question, or coupon.
InsightsByTabType Sorts insights by tab type, such as About, Ads, or Album.
InsightsByUnlikeSourceType Retrieves insights on actions users take to withdraw a previous "like" of your page.
SimpleInsights Displays simple insights (insights with a single value, given in response to a question) retrieved by your page.
VideoInsightsByActionType Returns video insights as the total number of likes, comments, or shares of that video. Valid only for the entire lifetime of the video posting.
VideoInsightsByDistributionType Displays video insights sorted by distribution type, such as owned, shared, or crossposted.
VideoInsightsByReactionType Retrieves video insights sorted by reaction type, such as like, love, wow, haha, sorty, and anger.

The sole stored procedure available for manipulating any of the above views is CreateInsightSchema.

For details about Facebook views, including some sample queries, see Views.

For a breakdown of insight mapping by category, see Insight Mapping Reference.

Recently Removed Insights

Since Facebook frequently makes changes to the available insights, the following table summarizes the insights most recently removed or renamed.

View or Stored Procedure Insight Name Available Periods Target Type
PageAndPostInsights PAGE_VIEWS_UNIQUE day, week page
InsightsByPaidStatus PAGE_STORYTELLERS_BY_STORY_TYPE day, week, days_28 page
InsightsByPaidStatus POST_IMPRESSIONS_BY_PAID_NON_PAID lifetime page
InsightsByPaidStatus PAGE_IMPRESSIONS_BY_PAID_NON_PAID day, week, days_28 page
InsightsByPaidStatus PAGE_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE day, week, days_28 page
InsightsByPaidStatus POST_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE lifetime page
InsightsByPaidStatus PAGE_POSTS_IMPRESSIONS_BY_PAID_NON_PAID day, week, days_28 page
InsightsByPaidStatus PAGE_POSTS_IMPRESSIONS_BY_PAID_NON_PAID_UNIQUE day, week, days_28 page

Facebook Connector for CData Sync

Insight Mapping Reference

The following provides a mapping of specific Facebook insights, showing which periods are available for them, what view they can be used from, and what types of targets are available.

See also: The Meta Developers Guide

Create Insight Schema

The following insights are derived from CreateInsightSchema:

Insight Name Available Periods Target Type Previous Name
PAGE_CONTENT_ACTIVITY_BY_AGE_GENDER_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_AGE_GENDER
PAGE_CONTENT_ACTIVITY_BY_CITY_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_CITY
PAGE_CONTENT_ACTIVITY_BY_COUNTRY_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_COUNTRY
PAGE_CONTENT_ACTIVITY_BY_LOCALE_UNIQUE day, week, days_28 page PAGE_STORYTELLERS_BY_LOCALE
PAGE_IMPRESSIONS_BY_CITY_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_BY_COUNTRY_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_BY_LOCALE_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_BY_AGE_GENDER_UNIQUE day, week, days_28 page -
PAGE_PLACES_CHECKINS_BY_AGE_GENDER day page -
PAGE_PLACES_CHECKINS_BY_LOCALE day page -
PAGE_PLACES_CHECKINS_BY_COUNTRY day page -
PAGE_FANS_LOCALE day page -
PAGE_FANS_CITY day page -
PAGE_FANS_COUNTRY day page -
PAGE_FANS_GENDER_AGE day page -
PAGE_VIEWS_EXTERNAL_REFERRALS day page -
POST_STORIES_BY_ACTION_TYPE lifetime post -
POST_STORYTELLERS_BY_ACTION_TYPE lifetime post -
PAGE_POSTS_IMPRESSIONS_FREQUENCY_DISTRIBUTION day, week, days_28 post -
POST_VIDEO_RETENTION_GRAPH lifetime post -


Page and Post Insights

The following insights are derived from PageAndPostInsights:

Insight Name Available Periods Target Type Previous Name
PAGE_ACTIONS_POST_REACTIONS_ANGER_TOTAL day page -
PAGE_ACTIONS_POST_REACTIONS_HAHA_TOTAL day page -
PAGE_ACTIONS_POST_REACTIONS_LIKE_TOTAL day page -
PAGE_ACTIONS_POST_REACTIONS_LOVE_TOTAL day page -
PAGE_ACTIONS_POST_REACTIONS_SORRY_TOTAL day page -
PAGE_ACTIONS_POST_REACTIONS_WOW_TOTAL day page -
PAGE_CONSUMPTIONS day, week, days_28 page -
PAGE_CONSUMPTIONS_UNIQUE day, week, days_28 page -
PAGE_ENGAGED_USERS day, week, days_28 page -
PAGE_FAN_ADDS day page -
PAGE_FAN_ADDS_UNIQUE day, week, days_28 page -
PAGE_FAN_REMOVES day page -
PAGE_FAN_REMOVES_UNIQUE day page -
PAGE_FANS day page -
PAGE_FANS_ONLINE day page -
PAGE_FANS_ONLINE_PER_DAY day page -
PAGE_IMPRESSIONS day, week, days_28 page -
PAGE_IMPRESSIONS_FREQUENCY_DISTRIBUTION day, week, days_28 page -
PAGE_IMPRESSIONS_ORGANIC day, week, days_28 page -
PAGE_IMPRESSIONS_ORGANIC_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_PAID day, week, days_28 page -
PAGE_IMPRESSIONS_PAID_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_UNIQUE day, week, days_28 page -
PAGE_IMPRESSIONS_VIRAL day, week, days_28 page -
PAGE_IMPRESSIONS_VIRAL_FREQUENCY_DISTRIBUTION day, week, days_28 page -
PAGE_IMPRESSIONS_VIRAL_UNIQUE day, week, days_28 page -
PAGE_NEGATIVE_FEEDBACK day, week, days_28 page -
PAGE_NEGATIVE_FEEDBACK_UNIQUE day, week, days_28 page -
PAGE_PLACES_CHECKIN_MOBILE day, week, days_28 page -
PAGE_PLACES_CHECKIN_MOBILE_UNIQUE day, week, days_28 page -
PAGE_PLACES_CHECKIN_TOTAL day, week, days_28 page -
PAGE_PLACES_CHECKIN_TOTAL_UNIQUE day, week, days_28 page -
PAGE_POST_ENGAGEMENTS day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_ORGANIC day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_ORGANIC_UNIQUE day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_PAID day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_UNIQUE day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_VIRAL day, week, days_28 page -
PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE day, week, days_28 page -
PAGE_CONTENT_ACTIVITY day, week, days_28 page PAGE_STORIES
PAGE_VIDEO_COMPLETE_VIEWS_30S day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_AUTOPLAYED day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_CLICK_TO_PLAY day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_ORGANIC day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_PAID day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_REPEAT_VIEWS day, week, days_28 page -
PAGE_VIDEO_COMPLETE_VIEWS_30S_UNIQUE day, week, days_28 page -
PAGE_VIDEO_REPEAT_VIEWS day, week, days_28 page -
PAGE_VIDEO_VIEWS day, week, days_28 page -
PAGE_VIDEO_VIEWS_AUTOPLAYED day, week, days_28 page -
PAGE_VIDEO_VIEWS_CLICK_TO_PLAY day, week, days_28 page -
PAGE_VIDEO_VIEWS_ORGANIC day, week, days_28 page -
PAGE_VIDEO_VIEWS_PAID day, week, days_28 page -
PAGE_VIDEO_VIEWS_UNIQUE day, week, days_28 page -
PAGE_VIEWS_TOTAL day, week, days_28 page PAGE_VIEWS
PAGE_VIEWS_LOGGED_IN_TOTAL day, week, days_28 page PAGE_VIEWS_LOGIN
PAGE_VIEWS_LOGGED_IN_UNIQUE day, week, days_28 page PAGE_VIEWS_LOGIN_UNIQUE
PAGE_VIEWS_LOGOUT day page -
POST_CLICKS lifetime post POST_CONSUMPTIONS
POST_CLICKS_UNIQUE lifetime post POST_CONSUMPTIONS_UNIQUE
POST_ENGAGED_USERS lifetime post -
POST_IMPRESSIONS lifetime post -
POST_IMPRESSIONS_FAN lifetime post -
POST_IMPRESSIONS_FAN_PAID lifetime post -
POST_IMPRESSIONS_FAN_PAID_UNIQUE lifetime post -
POST_IMPRESSIONS_FAN_UNIQUE lifetime post -
POST_IMPRESSIONS_ORGANIC lifetime post -
POST_IMPRESSIONS_ORGANIC_UNIQUE lifetime post -
POST_IMPRESSIONS_PAID lifetime post -
POST_IMPRESSIONS_PAID_UNIQUE lifetime post -
POST_IMPRESSIONS_UNIQUE lifetime post -
POST_IMPRESSIONS_VIRAL lifetime post -
POST_IMPRESSIONS_VIRAL_UNIQUE lifetime post -
POST_NEGATIVE_FEEDBACK lifetime post -
POST_NEGATIVE_FEEDBACK_UNIQUE lifetime post -
POST_ACTIVITY lifetime post POST_STORIES
POST_ACTIVITY_UNIQUE lifetime post POST_STORYTELLERS
POST_VIDEO_AVG_TIME_WATCHED lifetime post -
POST_VIDEO_COMPLETE_VIEWS_ORGANIC lifetime post -
POST_VIDEO_COMPLETE_VIEWS_ORGANIC_UNIQUE lifetime post -
POST_VIDEO_COMPLETE_VIEWS_PAID lifetime post -
POST_VIDEO_COMPLETE_VIEWS_PAID_UNIQUE lifetime post -
POST_VIDEO_LENGTH lifetime post -
POST_VIDEO_VIEW_TIME lifetime post -
POST_VIDEO_VIEW_TIME_ORGANIC lifetime post -
POST_VIDEO_VIEWS_10S lifetime post -
POST_VIDEO_VIEWS_10S_AUTOPLAYED lifetime post -
POST_VIDEO_VIEWS_10S_CLICKED_TO_PLAY lifetime post -
POST_VIDEO_VIEWS_10S_ORGANIC lifetime post -
POST_VIDEO_VIEWS_10S_PAID lifetime post -
POST_VIDEO_VIEWS_10S_SOUND_ON lifetime post -
POST_VIDEO_VIEWS_10S_UNIQUE lifetime post -
POST_VIDEO_VIEWS_ORGANIC lifetime post -
POST_VIDEO_VIEWS_ORGANIC_UNIQUE lifetime post -
POST_VIDEO_VIEWS_PAID lifetime post -
POST_VIDEO_VIEWS_PAID_UNIQUEPOST_VIDEO_VIEWS_SOUND_ON lifetime post -


Insights By Consumption Type

The following insights are derived from InsightsByConsumptionType:

Insight Name Available Periods Target Type Previous Name
PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE day, week, days_28 page -
PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE day, week, days_28 page -
POST_CLICKS_BY_TYPE lifetime post POST_CONSUMPTIONS_BY_CONSUMPTION_TYPE
POST_CLICKS_BY_TYPE_UNIQUE lifetime post POST_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE


Insights By Feedback Type

The following insights are derived from InsightsByFeedbackType:

Insight Name Available Periods Target Type Previous Name
PAGE_NEGATIVE_FEEDBACK_BY_TYPE day, week, days_28 page -
PAGE_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE day, week, days_28 page -
PAGE_POSITIVE_FEEDBACK_BY_TYPE day, week, days_28 page -
PAGE_POSITIVE_FEEDBACK_BY_TYPE_UNIQUE day, week, days_28 page -
POST_NEGATIVE_FEEDBACK_BY_TYPE lifetime post -
POST_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE lifetime post -


Insights By Like Source Type

The following insights are derived from InsightsByLikeSourceType:

Insight Name Available Periods Target Type Previous Name
PAGE_FANS_BY_LIKE_SOURCE day page -
PAGE_FANS_BY_LIKE_SOURCE_UNIQUE day page -


Insights By Un Like Source Type

The following insights are derived from InsightsByUnLikeSourceType:

Insight Name Available Periods Target Type Previous Name
PAGE_FANS_BY_UNLIKE_SOURCE day page -
PAGE_FANS_BY_UNLIKE_SOURCE_UNIQUE day page -


Insights By Reaction Totals

The following insights are derived from InsightsByReactionTotals:

Insight Name Available Periods Target Type Previous Name
PAGE_ACTIONS_POST_REACTIONS_TOTAL day page -
POST_REACTIONS_BY_TYPE_TOTAL day page -


Insights By Story Type

The following insights are derived from InsightsByStoryType:

Insight Name Available Periods Target Type Previous Name
PAGE_CONTENT_ACTIVITY_BY_ACTION_TYPE day, week, days_28 page PAGE_STORIES_BY_STORY_TYPE
PAGE_IMPRESSIONS_BY_STORY_TYPE day, week, days_28 page -
PAGE_IMPRESSIONS_BY_STORY_TYPE_UNIQUE day, week, days_28 page -
POST_IMPRESSIONS_BY_STORY_TYPE day, week, days_28 page -
POST_IMPRESSIONS_BY_STORY_TYPE_UNIQUE day, week, days_28 page -


Insights By Tab Type

The following insights are derived from InsightsByTabType:

Insight Name Available Periods Target Type Previous Name
PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE day, week page -
PAGE_TAB_VIEWS_LOGIN_TOP day, week page -
PAGE_TAB_VIEWS_LOGOUT_TOP day page -


Simple Video Insights

The following insights are derived from SimpleVideoInsights:

Insight Name Available Periods Target Type Previous Name
PAGE_VIDEO_VIEW_TIME day page -
TOTAL_VIDEO_VIEWS lifetime video -
TOTAL_VIDEO_VIEWS_UNIQUE lifetime video -
TOTAL_VIDEO_VIEWS_AUTOPLAYED lifetime video -
TOTAL_VIDEO_VIEWS_CLICKED_TO_PLAY lifetime video -
TOTAL_VIDEO_VIEWS_SOUND_ON lifetime video -
TOTAL_VIDEO_COMPLETE_VIEWS lifetime video -
TOTAL_VIDEO_COMPLETE_VIEWS_UNIQUE lifetime video -
TOTAL_VIDEO_COMPLETE_VIEWS_AUTO_PLAYED lifetime video -
TOTAL_VIDEO_COMPLETE_VIEWS_CLICKED_TO_PLAY lifetime video -
TOTAL_VIDEO_10S_VIEWS lifetime video -
TOTAL_VIDEO_10S_VIEWS_UNIQUE lifetime video -
TOTAL_VIDEO_10S_VIEWS_auto_played lifetime video -
TOTAL_VIDEO_10S_VIEWS_CLICKED_TO_PLAY lifetime video -
TOTAL_VIDEO_10S_VIEWS_SOUND_ON lifetime video -
TOTAL_VIDEO_AVG_TIME_WATCHED lifetime video -
TOTAL_VIDEO_VIEW_TOTAL_TIME lifetime video -
TOTAL_VIDEO_IMPRESSIONS lifetime video -
TOTAL_VIDEO_IMPRESSIONS_UNIQUE lifetime video -
TOTAL_VIDEO_IMPRESSIONS_VIRAL_UNIQUE lifetime video -
TOTAL_VIDEO_IMPRESSIONS_VIRAL lifetime video -
TOTAL_VIDEO_IMPRESSIONS_FAN_UNIQUE lifetime video -
TOTAL_VIDEO_IMPRESSIONS_FAN lifetime video -


Video Insights By Action Type

The following insights are derived from VideoInsightsByActionType:

Insight Name Available Periods Target Type Previous Name
TOTAL_VIDEO_STORIES_BY_ACTION_TYPE lifetime video -


Video Insights By Distribution Type

The following insights are derived from VideoInsightsByDistributionType:

Insight Name Available Periods Target Type Previous Name
TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE lifetime video -
TOTAL_VIDEO_VIEW_TIME_BY_DISTRIBUTION_TYPE lifetime video -


Video Insights By Reaction Type

The following insights are derived from VideoInsightsByReactionType:

Insight Name Available Periods Target Type Previous Name
TOTAL_VIDEO_REACTIONS_BY_TYPE_TOTAL lifetime video -

Facebook Connector for CData Sync

Datamodel Permissions

See Data Model for how the Sync App exposes Facebook APIs as different relational tables and views. This page offers a summary of permissions that might be required depending on how you use the Sync App.

Overview

Access and permissions to Facebook APIs broadly depend on whether you are pulling information for:

  • a User or things owned by a User
  • a Page or things owned by a Page

For information associated with a User or scoped to a User, access and permission are dependent on the set of permissions (scopes) that the user has approved for the OAuth application that accesses the Facebook API. For information associated with a Page, access and permission are controlled not only by the approvals given by a user to the OAuth application, but also by:

  • the approvals given by a user to the accessing OAuth application
  • the tasks assigned to the user on the Page
  • various Features approved for the application regardless of user
  • Page status on the Facebook platform

To access information associated with a User, the OAuth application that is used with the Sync App must be able to obtain some or all of the following permissions:

  • user_birthday
  • user_photos
  • user_videos
  • user_likes
  • user_hometown
  • user_location
  • user_tagged_places
  • public_profile

The user must also approve the OAuth application for these permissions when the user signs into Facebook to approve the application's access to their account.

To access information associated with a Page, the OAuth application that is used with the Sync App must be able to obtain some or all of the following permissions:

  • read_insights
  • pages_read_engagement
  • pages_manage_engagement
  • pages_show_list

The user must also approve the OAuth application for these permissions when the user signs into Facebook to approve the application's access to their account.

Additionally, when accessing Page information, depending on what they are trying to access, users might find that they need one of the following Tasks for the Page:

  • ANALYZE
  • MODERATE
  • CREATE_CONTENT
  • MANAGE

Alternatively, you can use the following features, if approved for an application, to access certain public Page information when the user does not have the requisite Task on the page:

  • Page Public Content Access (PPCA)
  • Page Public Metadata Access (PPMA)

Finally, the status of a Page can also factor into determining what sort of information can be obtained for or from it:

  • For Unpublished Pages, there are usually no restrictions for the Page data
  • For Published, Unrestricted Pages, limited data is available through PPCA or PPMA. More data specific to the Page, or specific to the users, pages, or other Facebook entities that have interacted with the Page, is available to those who have requested requisite permissions for pages, and who also have been assigned the Tasks needed for the Page. Non-public Page data may be further limited by privacy choices of the user, page, or entity that generated the non-public data on the Page.
  • For Published, Restricted Pages, data availability is covered by same permissions as for Published, Unrestricted pages, and additional requirements that the user must pass the restrictions, e.g., age or region, enforced for the Page.

Specific Permissions

The following shows the permissions, Tasks, or Features potentially required for each table or view. Whether each column is strictly required depends on your use case. Note that whether Page Permissions, Page Task, and Page Features are required depends on the status of the Page on Facebook and on the ownership relationship of the application user to the Page.

Table or View Name User or Non-Page Permissions Page Permissions Page Task Page Feature
Comments permissions for parent entity permissions for parent entity, pages_read_engagement, or pages_read_user_content MODERATE PPCA
Events N/A pages_read_engagement, pages_read_user_content, or pages_manage_metadata N/A N/A
Groups conditionally group_access_member_info N/A N/A N/A
InsightsByConsumptionType N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByFeedbackType N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByLikeSourceType N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByReactionTotals N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByStoryType N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByTabType N/A read_insights or pages_read_engagement ANALYZE N/A
InsightsByUnlikeType N/A read_insights or pages_read_engagement ANALYZE N/A
InstagramAccountInsights instagram_basic and instagram_manage_insights N/A N/A N/A
Likes permissions for parent entity N/A N/A N/A
PageAndPostInsights N/A read_insights or pages_read_engagement ANALYZE N/A
Pages pages_show_list pages_read_engagement or pages_read_user_content, pages_show_list MODERATE PPCA,PPMA
Photos user_photos pages_read_engagement or pages_read_user_content MODERATE N/A
Places user_location N/A N/A N/A
Posts user_posts pages_read_engagement or pages_read_user_content MODERATE, CREATE_CONTENT, or MANAGE PPCA
Ratings N/A pages_read_user_content MODERATE, CREATE_CONTENT, or MANAGE N/A
SimpleVideoInsights N/A read_insights or pages_read_engagement ANALYZE N/A
StoryAttachments permissions for parent entity permissions for parent entity N/A N/A
TaggedBy N/A pages_read_user_content, pages_show_list MODERATE, CREATE_CONTENT, or MANAGE N/A
Users public_profile, user_location N/A N/A N/A
VideoInsightsByActionType N/A read_insights or pages_read_engagement ANALYZE N/A
VideoInsightsByDistributionType N/A read_insights or pages_read_engagement ANALYZE N/A
VideoInsightsByReactionType N/A read_insights or pages_read_engagement ANALYZE N/A
Videos user_videos or user_posts pages_read_engagement or pages_read_user_content MANAGE PPCA
Wall user_posts pages_read_engagement or pages_read_user_content MODERATE, CREATE_CONTENT, MANAGE PPCA

Facebook Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Facebook 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 Facebook 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.

Facebook Connector for CData Sync

SSL Configuration

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.

Facebook Connector for CData Sync

Firewall and Proxy

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.

Facebook Connector for CData Sync

Data Model

The CData Sync App models Facebook APIs as relational Tables, Views, and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Facebook Connector for CData Sync

Tables

The Sync App models the data in Facebook as a list of tables in a relational database that can be queried using standard SQL statements.

Facebook Connector for CData Sync Tables

Name Description
Likes Create, delete, and query the Likes for a Target. Alternatively, lists Pages that the specified User or Page Likes. Authentication is required to use this table.
Posts Create, delete, and query the Posts for a Target based on either the Target or Id. Posts can also be inserted based on a Target, or deleted based on Id. This table requires authentication.

Facebook Connector for CData Sync

Likes

Create, delete, and query the Likes for a Target. Alternatively, lists Pages that the specified User or Page Likes. Authentication is required to use this table.

Table Specific Information

Likes is an advanced table and require you to set the Target column in the SQL query.

Likes in Facebook represent the users that like a particular target. The target may be a post, picture, or other type of valid entity that may have likes associated with it.

Note: At this time, the Likes table cannot retrieve likes or other reactions for pages. To retrieve simple insights for pages under the new Page experience from Facebook, see PageAndPostInsights.

Select

When selecting likes, specify a target. The target represents the username or Id of the entity that likes are being retrieved for. For example:

SELECT Id, Name, Picture FROM Likes WHERE Target = '15526475270_410830705612736'

If a user or page is specified as the target for likes, then the pages that the user or page likes will be returned. For example:

SELECT Id, Name, Username, Category FROM Likes WHERE Target = 'facebook'

If no target is specified, the currently authenticated user will be used as the target. In this case, the pages that the authenticated user likes will be returned.

Insert

To insert a like or to like something, simply issue an INSERT statement and specify the target you are liking. The target must be an album, checkin, comment, photo, post, status update, or other object that can be liked. For example:

INSERT INTO Likes (Target) VALUES ('123456789_123456789')

Update

Facebook does not allow likes to be updated.

Delete

Facebook does not allow likes to be deleted.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of a user who likes the target, which may or may not be combined with the target Id. The user Id will be after the final '_'.

Target [KEY] String False

The Id or username of the target being liked. This may be a post, page, picture, or other valid id with likes.

Name String True

The name of the user who likes the target. May alternatively be the name of a page.

Username String True

The username of a page when retrieving pages a page has liked.

Picture String True

Picture of the user who likes the target. May alternatively be the picture of a page.

Category String True

The category of the user or page.

CreatedTime Datetime True

The time the like was created, if available.

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. For more information, see the WHERE clause section.

Name Type Description
offset String

Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Posts

Create, delete, and query the Posts for a Target based on either the Target or Id. Posts can also be inserted based on a Target, or deleted based on Id. This table requires authentication.

Table Specific Information

Posts in Facebook are posts to a user's profile feed. Posts can be made to a user, page, application, group, or event.

Note: Due to a deprecation in the Facebook API, queries to the Comments, Photos, Posts, and Videos views where a user profile is either the defined or default target, no longer return data for the following fields:

  • comments
  • message_tags
  • reactions
  • sharedposts
  • story
  • story_tags
  • to
  • via
For further information, see https://developers.facebook.com/docs/graph-api/changelog/version16.0.

Select

When selecting posts, a target may be specified. The target represents a page or another valid entity that may have posts for it. If no target is specified, the authenticated user will be used as the target. For example, to retrieve posts made by a page:

SELECT * FROM Posts WHERE Target = 'PageId'

If you know the post Id, you can specify the Id to obtain information about the specific post. For example:

SELECT * FROM Posts WHERE Id = 'PostId'

When querying posts, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Posts WHERE Target = 'facebook' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '2/1/2012'

Insert

To insert a post, you will need to specify the Target and Message of the post. For instance:

INSERT INTO Posts (Message, Target) VALUES ('My New Post', 'PageId')

Create a photo post by using the Link or ObjectId columns. With the Link column, specify the accessible URL of an image to add the post to. You can also create video posts:

INSERT INTO Posts (Message, Target, Link) VALUES ('My New Post', 'PageId', 'http://imagerepo.net/testimage.png)'

INSERT INTO Posts (Message, Target, Link) VALUES ('My New Post', 'PageId', 'http://samplevideos.net/newmovie.mp4)'

You can also set local files in the Link column to upload media. Note that you must set UploadLinkedMedia to true for this to work:

INSERT INTO Posts (Message, Target, Link) VALUES ('From Local', 'PageId', 'file://D://test/sample.mp4')

With the ObjectId column, specify the ID of an unpublished photo in your account. To upload a photo without publishing it, use the UploadPhoto stored procedure. Video Ids are not supported:

INSERT INTO Posts (Message, Target, ObjectId) VALUES ('My New Post', 'PageId', '43572')

Update

Facebook does not allow posts to be updated.

Delete

Posts can be deleted by issuing a DELETE statement and specifying the Id of the post. Please note that Facebook allows only posts created by your app to be deleted using your app.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of the post.

Target String False

The Id or username of the target you are retrieving posts for or are posting to. This can be an event, page, or user.

FromId String True

Id of the user who made the post.

FromName String True

Name of the user who made the post.

FromPicture String True

Picture of the user who made the post.

FromCategory String True

Category of the user who made the post. FromCategory can only be retrieved if the other From* fields are not selected.

ToData String True

An aggregate of users the post was made to.

Message String False

The message of the post. A message is required when inserting a post.

MessageTags String True

An aggregate of objects tagged in the message such as users, pages, etc.

Attachments String True

An aggregate for the attachments of the post.

Picture String False

A link to the picture included in the post.

FullPicture String False

A link to the original picture included in the post. The one listed in Picture may be a resized smaller version.

Icon String True

Link to an icon representing the type of post.

Actions String True

An aggregate of available actions on the post such as commenting or liking.

CommentsCount Integer True

The number of comments for the post.

LikesCount Integer True

The number of times the post has been liked.

SharesCount Integer True

The number of times the post has been shared.

PlaceId String False

The Id of the location associated with the post, if any.

PlaceName String True

The name of the location associated with the post, if any.

ApplicationId String True

Id of the application this post came from.

ApplicationName String True

Name of the application this post came from.

ApplicationCanvasName String True

Information about the application used to create the entity.

ApplicationNamespace String True

Information about the application used to create the entity.

Story String True

Text of stories not intentionally generated by users, such as those generated when two users become friends; you must have the Include Recent Activity Stories migration enabled in your app to retrieve these stories. Requires the read_stream permission.

StoryTags String True

An aggregate of objects (users, pages, etc.) associated with the story.

LikesData String True

An aggregate of like data.

CommentsData String True

An aggregate of comments for this post.

CreatedTime Datetime True

When the post was created.

UpdatedTime Datetime True

When the post was last updated.

PermalinkUrl String True

The permanent static URL to the post on www.facebook.com

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. For more information, see the WHERE clause section.

Name Type Description
TaggedUser String

If set to an Id or username, it will retrieve posts where the specified user has been tagged. Requires the read_stream permission.

LocationUser String

If set to an Id or username, it will retrieve location posts where the user has been tagged. Requires the user_photos and user_status permissions.

Link String

A link to attach to the post. For use with the creation of posts. For post creation, either Link or Message columns are required.

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

Facebook Connector for CData Sync Views

Name Description
Comments Create, update, delete, and query the Comments for a Target. Comments may also be inserted based on a Target or deleted based on Id.
Events Query the Events for a Target such as a page id.
InsightsByConsumptionType Allows retrieval of insights by consumption type.
InsightsByFeedbackType Allows retrieval of insights by feedback type.
InsightsByLikeSourceType Allows retrieval of insights by like source type.
InsightsByReactionTotals Allows retrieval of insights by like source type.
InsightsByStoryType Allows retrieval of insights by like story type.
InsightsByTabType Allows retrieval of insights by tab type..
InsightsByUnLikeSourceType Allows retrieval of insights by like source type.
InstagramAccountInsights Allows you to get insights for an Instagram Business Account. Requires the instagram_basic and instagram_manage_insights scopes.
PageAndPostInsights Allows the retrieval of simple insights with a single value in the response.
PageLiveVideos Live videos on a specified page. This table requires authentication, and the pages_read_engagement (or Page Public Content Access feature if you cannot moderate the page) and pages_show_list permissions. The Page Id must be specified as the Target.
Pages Query the Pages based on the supplied Id.
Permissions Query the Permissions the User has granted the current application.
Photos Query Photos associated with a Target. Accessing Photo information typically requires the user_photos permission.
Places Query the Places based on the supplied Id. Places are stored as Pages in Facebook.
PostSponsorTags Query the Pages that have sponsored a target post. This table requires authentication, and the Post Id must be specified as the Target.
Ratings List of ratings for a Facebook Page. This view requires authentication.
SimpleVideoInsights Allows the retrieval of simple video insights with a single value in the response.
StoryAttachments Query attachments from a post or comment.
TaggedBy Query information about Posts, Statuses, Photos, and other entities that have tagged the User or Page. This view is a derivative of the Wall connection where only entries that have tagged the Target User or Page will be returned. In general it is only available for Pages.
Users Returns basic information about the authenticated user.
VideoInsightsByActionType Allows the retrieval of video insights by story action type.
VideoInsightsByDistributionType Allows the retrieval of video insights by distribution type.
VideoInsightsByReactionType Allows the retrieval of video insights by reaction type.
VideoReels Query reels for a given page.
Videos Query Videos from a Target. Normally requires the user_videos permission.
Wall Query Posts from the Wall of a Target.

Facebook Connector for CData Sync

Comments

Create, update, delete, and query the Comments for a Target. Comments may also be inserted based on a Target or deleted based on Id.

Table Specific Information

Comments in Facebook are comments about a specific thing. They are always associated with a target, which is the item the comment is directed toward. For example, this could be a post, a picture, or a video. Using this table, you can list the comments for a specific target and also insert new comments about a target.

Note: Due to a deprecation in the Facebook API, queries to the Comments, Photos, Posts, and Videos views where a user profile is either the defined or default target, no longer return data for the following fields:

  • comments
  • message_tags
  • reactions
  • sharedposts
  • story
  • story_tags
  • to
  • via
For further information, see https://developers.facebook.com/docs/graph-api/changelog/version16.0.

Select

When querying comments, either the Target or the Id of the comment may be specified. For example, to retrieve all the comments about a specific post, your SELECT statement could look something like this:

SELECT * FROM Comments WHERE Target = '15526475270_410830705612736'

Alternatively, you can specify the Id to retrieve a specific comment. For example:

SELECT * FROM Comments WHERE Id = '15526475270_410830705612736_5193593'

If no Target or Id is specified, comments will be queried from the posts of the feed of the currently authenticated user or page.

Multiple queries can also be composed together to retrieve comments from posts across multiple Facebook entities. For instance:

SELECT * FROM Comments WHERE Target IN (SELECT Id FROM Posts WHERE Target IN (SELECT Id FROM Pages))

If you are looking for comments for all posts, please consider looking at the Posts table or the Wall view. They contain the columns 'CommentsData' and 'CommentsCount'. 'CommentsCount' can be queried to filter and only select posts (targets) on which a comment has been made:

SELECT * FROM Wall WHERE CommentsCount > 0

Columns

Name Type Description
ID [KEY] String The Id of the comment.
Target String The Id of the target you are retrieving comments for. This may be an album, checkin, link, note, photo, post, status update, or video.
FromId String Id of the user who made the comment.
FromName String Name of the user who made the comment.
FromPicture String Picture of the user who made the comment.
Message String The text of the comment.
MessageTags String Aggregate of tags contained in the message.
Likes Integer The number of likes the comment has.
CommentsCount Integer The number of comments in reply to this comment.
LikesData String Aggregate of likes information on the comment.
UserLikes Boolean Boolean indicating if the authenticated user likes the comment.
CanRemove Boolean Boolean indicating if the comment can be removed.
Attachments String An aggregate for the attachments of the post.
CreatedTime Datetime The time the comment 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. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Events

Query the Events for a Target such as a page id.

Table Specific Information

Events in Facebook are events created by a user or page that mark a specific date when something will take place. Events may be queried by Target or Id.

Select

When selecting events, a target may be specified. The target represents a page that has created events. By default, this will be the currently authenticated user or page. For example, to retrieve events associated with a page:

SELECT * FROM Events WHERE Target = 'PageId'

If you know the event Id, you may also just specify the Id to obtain information about the specific event. For example:

SELECT * FROM Events WHERE Id = 'EventId'

Columns

Name Type Description
ID [KEY] String The Id of the event.
Target String The Id or username of the target you are retrieving events for or are posting events to. This may be a page or a user.
Name String The name of the event.
StartTime Datetime The start time of the event.
EndTime Datetime The end time of the event.
Timezone String The time zone the event will take place in.
Description String The description of the event.
Picture String A URL to the picture of the event.
OwnerId String The Id of the user that created the event.
OwnerName String The name of the user that created the event.
OwnerPicture String Picture of the user who created the event.
OwnerCategory String Category of the owner, if available.
Location String The location of the event, if specified.
LocationId String The Id of the location for the event.
LocationStreet String The street address of the event.
LocationCity String The the city for the event.
LocationState String The the state for the event.
LocationCountry String The the country for the event.
LocationZip String The the ZIP code of the event.
LocationLatitude String The latitude of the event.
LocationLongitude String The longitude of the event.
TicketUri String A URL to a location to buy tickets for this event.
UpdatedTime Datetime When the event was last updated.
AttendingCount Integer Number of people attending the event.
DeclinedCount Integer Number of people who declined the event.
InterestedCount Integer Number of people interested in the event.
MaybeCount Integer Number of people who maybe going to the event.
NoreplyCount Integer Number of people who did not reply to the event.

Facebook Connector for CData Sync

InsightsByConsumptionType

Allows retrieval of insights by consumption type.

Table Specific Information

Insights by consumption type refers to any insights that can be retrieved from a page or post that measure how users consumed your content.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByConsumptionType WHERE Target = 'mypostid' AND InsightName = 'PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByConsumptionType WHERE Target = 'mypostid' AND InsightName = 'PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Datetime The most recent date this insight data is relevant for.
VideoPlay Long Insight column indication the total for the stated consumption type.
OtherClicks Long Insight column indication the total for the stated consumption type.
PhotoView Long Insight column indication the total for the stated consumption type.
LinkClicks Long Insight column indication the total for the stated consumption type.
ButtonClicks Long Insight column indication the total for the stated consumption type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE,PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE,POST_CLICKS_BY_TYPE,POST_CLICKS_BY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByFeedbackType

Allows retrieval of insights by feedback type.

Table Specific Information

Insights by feedback type refers to any insights that can be retrieved from a page or post that measure what kind of feedback was left.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByFeedbackType WHERE Target = 'mypostid' AND InsightName = 'PAGE_POSITIVE_FEEDBACK_BY_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByFeedbackType WHERE Target = 'mypostid' AND InsightName = 'PAGE_POSITIVE_FEEDBACK_BY_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Like Long Insight column indication the total for the positive feedback type.
Comment Long Insight column indication the total for the positive feedback type.
Link Long Insight column indication the total for the positive feedback type.
Answer Long Insight column indication the total for the positive feedback type.
Claim Long Insight column indication the total for the positive feedback type.
Rsvp Long Insight column indication the total for the positive feedback type.
HideAllClicks Long Insight column indication the total for the negative feedback type.
HideClicks Long Insight column indication the total for the negative feedback type.
UnlikePageClicks Long Insight column indication the total for the negative feedback type.
ReportSpamClicks Long Insight column indication the total for the negative feedback type.
XButtonClicks Long Insight column indication the total for the negative feedback type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_NEGATIVE_FEEDBACK_BY_TYPE,PAGE_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE,PAGE_POSITIVE_FEEDBACK_BY_TYPE,PAGE_POSITIVE_FEEDBACK_BY_TYPE_UNIQUE,POST_NEGATIVE_FEEDBACK_BY_TYPE,POST_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByLikeSourceType

Allows retrieval of insights by like source type.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Ads Long Insight column indication the total for the like source type.
NewsFeed Long Insight column indication the total for the like source type.
Other Long Insight column indication the total for the like source type.
PageSuggestions Long Insight column indication the total for the like source type.
RestoredLikesFromReactivatedAccounts Long Insight column indication the total for the like source type.
Search Long Insight column indication the total for the like source type.
YourPage Long Insight column indication the total for the like source type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_FANS_BY_LIKE_SOURCE,PAGE_FANS_BY_LIKE_SOURCE_UNIQUE

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByReactionTotals

Allows retrieval of insights by like source type.

Table Specific Information

Insights by reaction total type refers to the reaction totals for your page or post.

Select

When selecting insights, a Target must be specified. This should be set to a page or post depending on the InsightName specified. You can set InsightName to 'PAGE_ACTIONS_POST_REACTIONS_TOTAL' or 'POST_REACTIONS_BY_TYPE_TOTAL', by default it will be 'PAGE_ACTIONS_POST_REACTIONS_TOTAL'. For instance:

SELECT * FROM InsightsByReactionTotals WHERE Target = 'mypageid' AND InsightName = 'PAGE_ACTIONS_POST_REACTIONS_TOTAL'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByReactionTotals WHERE Target = 'mypageid' AND InsightName = 'PAGE_ACTIONS_POST_REACTIONS_TOTAL' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Like Long Total like reactions.
Love Long Total love reactions.
Wow Long Total wow reactions.
Haha Long Total haha reactions.
Sorry Long Total sorry reactions.
Anger Long Total anger reactions.
Thankful Long Total thankful reactions.
Pride Long Total pride reactions.
Care Long Total care reactions.
Fire Long Total fire reactions.
Hundred Long Total hundred reactions.
Target String The target of the insight. 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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.
InsightName String Insight Name. The available values are: PAGE_ACTIONS_POST_REACTIONS_TOTAL,POST_REACTIONS_BY_TYPE_TOTAL

The default value is PAGE_ACTIONS_POST_REACTIONS_TOTAL.

Facebook Connector for CData Sync

InsightsByStoryType

Allows retrieval of insights by like story type.

Table Specific Information

Insights by story type refers to any insights that can be retrieved from a page or post that measure the types of stories that have occurred.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByStoryType WHERE Target = 'mypostid' AND InsightName = 'PAGE_STORIES_BY_STORY_TYPE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByStoryType WHERE Target = 'mypostid' AND InsightName = 'PAGE_STORIES_BY_STORY_TYPE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
UserPost Long Insight column indication the total for the stated story type.
PagePost Long Insight column indication the total for the stated story type.
Checkin Long Insight column indication the total for the stated story type.
Fan Long Insight column indication the total for the stated story type.
Question Long Insight column indication the total for the stated story type.
Coupon Long Insight column indication the total for the stated story type.
Event Long Insight column indication the total for the stated story type.
Mention Long Insight column indication the total for the stated story type.
Other Long Insight column indication the total for the stated story type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_CONTENT_ACTIVITY_BY_ACTION_TYPE,PAGE_IMPRESSIONS_BY_STORY_TYPE,PAGE_IMPRESSIONS_BY_STORY_TYPE_UNIQUE,POST_IMPRESSIONS_BY_STORY_TYPE,POST_IMPRESSIONS_BY_STORY_TYPE_UNIQUE
Period String The period for the insight. This must always be specified.

The allowed values are day, week, days_28, lifetime.

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByTabType

Allows retrieval of insights by tab type..

Table Specific Information

Insights by tab type refers to any insights that can be retrieved from a page or post that measure what tab was used to view your content.

Select

When selecting insights, a Target must be specified. In addition, an InsightName and Period should always be specified. For instance:

SELECT * FROM InsightsByTabType WHERE Target = 'mypostid' AND InsightName = 'PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE' AND Period = 'day'

Additionally, StartTime and EndTime can be used to specify a range where insight data should be drawn from:

SELECT * FROM InsightsByTabType WHERE Target = 'mypostid' AND InsightName = 'PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
About Long Insight column indication the total for the tab type.
Ads Long Insight column indication the total for the tab type.
Album Long Insight column indication the total for the tab type.
AllActivity Long Insight column indication the total for the tab type.
App Long Insight column indication the total for the tab type.
Community Long Insight column indication the total for the tab type.
Events Long Insight column indication the total for the tab type.
Home Long Insight column indication the total for the tab type.
Info Long Insight column indication the total for the tab type.
Insights Long Insight column indication the total for the tab type.
Jobs Long Insight column indication the total for the tab type.
Likes Long Insight column indication the total for the tab type.
Locations Long Insight column indication the total for the tab type.
Notes Long Insight column indication the total for the tab type.
Photos Long Insight column indication the total for the tab type.
PhotosAlbums Long Insight column indication the total for the tab type.
PhotosStream Long Insight column indication the total for the tab type.
Posts Long Insight column indication the total for the tab type.
Profile Long Insight column indication the total for the tab type.
ProfileAbout Long Insight column indication the total for the tab type.
ProfileCommunity Long Insight column indication the total for the tab type.
ProfileHome Long Insight column indication the total for the tab type.
ProfileInfo Long Insight column indication the total for the tab type.
ProfileLikes Long Insight column indication the total for the tab type.
ProfilePhotos Long Insight column indication the total for the tab type.
ProfilePosts Long Insight column indication the total for the tab type.
Reviews Long Insight column indication the total for the tab type.
Timeline Long Insight column indication the total for the tab type.
Videos Long Insight column indication the total for the tab type.
Wall Long Insight column indication the total for the tab type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE,PAGE_TAB_VIEWS_LOGIN_TOP,PAGE_TAB_VIEWS_LOGOUT_TOP
Period String The period for the insight. This must always be specified.

The allowed values are day, week.

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InsightsByUnLikeSourceType

Allows retrieval of insights by like source type.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
DeactivatedOrMemorializedAccountRemovals Long Insight column indication the total for the like source type.
SuspiciousAccountRemovals Long Insight column indication the total for the like source type.
UnlikesFromPagePostsOrNewsFeed Long Insight column indication the total for the like source type.
UnlikesFromSearch Long Insight column indication the total for the like source type.
UnderageAccountRemovals Long Insight column indication the total for the like source type.
UnlikesFromPageSuggestions Long Insight column indication the total for the like source type.
Other Long Insight column indication the total for the like source type.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: PAGE_FANS_BY_UNLIKE_SOURCE,PAGE_FANS_BY_UNLIKE_SOURCE_UNIQUE

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

InstagramAccountInsights

Allows you to get insights for an Instagram Business Account. Requires the instagram_basic and instagram_manage_insights scopes.

Columns

Name Type Description
RowNumber [KEY] String The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Value Long Insight column for a singular value response.
Description 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.

The allowed values are day, week, days_28, lifetime.

InsightName String The name of the insight. This must always be specified. The available values are: IMPRESSIONS,REACH,FOLLOWER_COUNT,EMAIL_CONTACTS,PHONE_CALL_CLICKS,TEXT_MESSAGE_CLICKS,GET_DIRECTIONS_CLICKS,WEBSITE_CLICKS,PROFILE_VIEWS,AUDIENCE_GENDER_AGE,AUDIENCE_COUNTRY,AUDIENCE_CITY,ONLINE_FOLLOWERS
InsightBreakdownValue String The values for an insight breakdown. Applies to AUDIENCE_GENDER_AGE, AUDIENCE_COUNTRY, AUDIENCE_CITY.
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. Only 'lifetime' is valid for AUDIENCE_GENDER_AGE, AUDIENCE_COUNTRY, and AUDIENCE_CITY.

The allowed values are day, week, days_28, lifetime.

Timeframe String Designates how far to look back for data. Required for AUDIENCE_GENDER_AGE, AUDIENCE_COUNTRY, and AUDIENCE_CITY, and takes the place of FromDateTime and ToDateTime inputs for these insights.

The allowed values are last_14_days, last_30_days, last_90_days, prev_month, this_month, this_week.

Target String The target of the insight. This value correspond to the InstagramBusinessAccountId of the Pages view. You can also set it to 'Target IN (SELECT InstagramBusinessAccountId FROM Pages)'. 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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

PageAndPostInsights

Allows the retrieval of simple insights with a single value in the response.

Table Specific Information

Page and Post insights that can be retrieved from a page or post. These kinds of insights have a single value in the response and can only be filtered by a few values.

Select

When selecting Page and Post insights, always specify a Target and a Period. To improve performance, an InsightName should be specified as well. For example:

SELECT * FROM PageAndPostInsights WHERE Target = 'mypageid' AND InsightName = 'PAGE_IMPRESSIONS' AND Period = 'day'

To specify multiple insights, use the IN operator. For example:

SELECT * FROM PageAndPostInsights WHERE Target = 'mypageid' AND InsightName IN ('PAGE_IMPRESSIONS', 'PAGE_ENGAGED_USERS') AND Period = 'day'

To specify a range within which insight data should be drawn, use StartTime and EndTime. For example:

SELECT * FROM PageAndPostInsights WHERE Target = 'mypageid' AND InsightName = 'PAGE_IMPRESSIONS' AND Period = 'day' AND EndTime >= '12/1/2015' AND EndTime <= '12/31/2015'

Note: Be aware that not all periods are available for all insights. Some will support the use of day/week/days_28 available, but others may only support lifetime. If you are not sure what periods are supported for the insight of interest, see https://developers.facebook.com/docs/graph-api/reference/insights.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
EndTime Date The most recent date this insight data is relevant for.
Value Long Insight column for a singular value response.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This can be specified to improve performance. The available values are: PAGE_ACTIONS_POST_REACTIONS_ANGER_TOTAL, PAGE_ACTIONS_POST_REACTIONS_HAHA_TOTAL, PAGE_ACTIONS_POST_REACTIONS_LIKE_TOTAL, PAGE_ACTIONS_POST_REACTIONS_LOVE_TOTAL, PAGE_ACTIONS_POST_REACTIONS_SORRY_TOTAL, PAGE_ACTIONS_POST_REACTIONS_WOW_TOTAL, PAGE_FAN_ADDS, PAGE_FAN_ADDS_UNIQUE, PAGE_FAN_REMOVES, PAGE_FAN_REMOVES_UNIQUE, PAGE_FANS, PAGE_IMPRESSIONS, PAGE_IMPRESSIONS_PAID, PAGE_IMPRESSIONS_PAID_UNIQUE, PAGE_IMPRESSIONS_UNIQUE, PAGE_IMPRESSIONS_VIRAL, PAGE_IMPRESSIONS_VIRAL_UNIQUE, PAGE_IMPRESSIONS_NONVIRAL, PAGE_IMPRESSIONS_NONVIRAL_UNIQUE, PAGE_POST_ENGAGEMENTS, PAGE_POSTS_IMPRESSIONS, PAGE_POSTS_IMPRESSIONS_PAID, PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE, PAGE_POSTS_IMPRESSIONS_UNIQUE, PAGE_POSTS_IMPRESSIONS_VIRAL, PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE, PAGE_VIDEO_COMPLETE_VIEWS_30S, PAGE_VIDEO_COMPLETE_VIEWS_30S_AUTOPLAYED, PAGE_VIDEO_COMPLETE_VIEWS_30S_CLICK_TO_PLAY, PAGE_VIDEO_COMPLETE_VIEWS_30S_ORGANIC, PAGE_VIDEO_COMPLETE_VIEWS_30S_PAID, PAGE_VIDEO_COMPLETE_VIEWS_30S_REPEAT_VIEWS, PAGE_VIDEO_COMPLETE_VIEWS_30S_UNIQUE, PAGE_VIDEO_REPEAT_VIEWS, PAGE_VIDEO_VIEWS, PAGE_VIDEO_VIEWS_AUTOPLAYED, PAGE_VIDEO_VIEWS_CLICK_TO_PLAY, PAGE_VIDEO_VIEWS_ORGANIC, PAGE_VIDEO_VIEWS_PAID, PAGE_VIDEO_VIEWS_UNIQUE, PAGE_VIEWS_TOTAL, POST_CLICKS, POST_IMPRESSIONS, POST_IMPRESSIONS_FAN, POST_IMPRESSIONS_FAN_UNIQUE, POST_IMPRESSIONS_ORGANIC, POST_IMPRESSIONS_ORGANIC_UNIQUE, POST_IMPRESSIONS_PAID, POST_IMPRESSIONS_PAID_UNIQUE, POST_IMPRESSIONS_UNIQUE, POST_IMPRESSIONS_VIRAL, POST_IMPRESSIONS_VIRAL_UNIQUE, POST_VIDEO_AVG_TIME_WATCHED, POST_VIDEO_COMPLETE_VIEWS_ORGANIC, POST_VIDEO_COMPLETE_VIEWS_ORGANIC_UNIQUE, POST_VIDEO_COMPLETE_VIEWS_PAID, POST_VIDEO_COMPLETE_VIEWS_PAID_UNIQUE, POST_VIDEO_LENGTH, POST_VIDEO_VIEW_TIME, POST_VIDEO_VIEW_TIME_ORGANIC, POST_VIDEO_VIEWS_15S, POST_VIDEO_VIEWS_ORGANIC, POST_VIDEO_VIEWS_ORGANIC_UNIQUE, POST_VIDEO_VIEWS_PAID, POST_VIDEO_VIEWS_PAID_UNIQUE, POST_VIDEO_VIEWS_SOUND_ON
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.

The allowed values are day, week, days_28, lifetime.

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

PageLiveVideos

Live videos on a specified page. This table requires authentication, and the pages_read_engagement (or Page Public Content Access feature if you cannot moderate the page) and pages_show_list permissions. The Page Id must be specified as the Target.

Columns

Name Type Description
ID [KEY] String The Id of the post.
Title String The title of the live video.
Status String The status of the LiveVideo.
StreamUrl String The stream url of the live video.
SecureStreamUrl String The secure stream url of the live video. Check with your encoder whether this is supported before adapting.
EmbedHtml String The embed html of the live video.
BroadcastStartTime Datetime The time the video was initially published.
CreationTime Datetime The creation time of the live video.
DashIngestUrl String The dash ingest stream URL of the live video.
DashPreviewUrl String Preview URL for dash player.
Description String The description of the live video.
FromName String The name of the originator of the live video.
FromId String The id of the originator of the live video.
TargetingAgeMax Integer The maximum age of viewers to target the video toward.
TargetingAgeMin Integer The minimum age of viewers to target the video toward.
TargetingCountries String The countries of viewers to target the video toward.
PermalinkUrl String The permalink URL of this video on Facebook.
VideoId String The Id of the video.
Target String ID of the page of the live videos.

Facebook Connector for CData Sync

Pages

Query the Pages based on the supplied Id.

Table Specific Information

Pages in Facebook are pages that are created by a user and may be maintained by one or multiple users. Pages, like users, may be referred to by Id or by screen name.

Select

When querying pages, if nothing is specified then the pages you administrate will be displayed by default. Otherwise, the Id of the page can be specified. For example:

SELECT * FROM Pages WHERE Id = 'facebook'

Columns

Name Type Description
ID [KEY] String The Id of the page.
Username String The username for the page, if any.
Name String The name of the page.
Category String The category of the page.
Categories String An aggregate of categories associated with the page if multiple categories are available.
Link String A link to the page.
Picture String A link to the profile picture of the page for the page.
CoverId String Id of the cover image for the page.
CoverSource String The URL to the cover image for the page.
CoverOffsetY String The y-axis offset of the cover image for the page.
CoverOffsetX String The x-axis offset of the cover image for the page.
About String Basic information about the page.
Description String A description of the page, if available.
GeneralInfo String General information provided by the page.
LocationStreet String The street address of the page.
LocationCity String The city for the page.
LocationState String The state for the page.
LocationCountry String The country for the page.
LocationZip String The ZIP code of the page.
LocationLatitude String The latitude of the page.
LocationLongitude String The longitude of the page.
StoreNumber Integer Unique store number for this location page, if applicable.
Phone String The phone number of the page, if available.
Website String A link to the website for the page.
Likes Integer The number of people who like the page.
Checkins Integer The total number of users who have checked in to the place associated with the page.
TalkingAboutCount Integer The number of users talking about the page.
WereHereCount Integer The number of users who were at the location the page is for, if applicable.
CanPost Boolean Boolean indicating if the authenticated user can post of the page for the page.
IsPublished Boolean Boolean indicating if the page for the page has been published.
IsCommunityPage Boolean Boolean indicating if this is a community page.
PublicTransit String The public transit available for the page, if any.
ParkingStreet Boolean Boolean indicating if street parking is available.
ParkingLot Boolean Boolean indicating if a parking lot is available.
ParkingValet Boolean Boolean indicating if valet parking is available.
PromotionEligible Boolean Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page.
PromotionIneligibleReason String Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page.
Founded String When the company is founded. Applicable to companies.
Mission String The company mission. Applicable to companies.
Products String The products of this company. Applicable to companies.
Hours String An aggregate for the hours of operation. Applicable to businesses and places.
Attire String Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified.
AcceptsCashOnly Boolean Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife.
AcceptsVisa Boolean Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife.
AcceptsAmericanExpress Boolean Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife.
AcceptsMasterCard Boolean Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife.
AcceptsDiscover Boolean Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife.
PriceRange String Price range of the business. Applicable to restaurants or nightlife. Valid values are \$ (0-10), \$\$ (10-30), \$\$\$ (30-50), \$\$\$\$ (50+), or Unspecified.
TakesReservations Boolean Whether the restaurant takes reservations. Only applicable to restaurants.
AllowsWalkins Boolean Whether the restaurant allows walk-ins. Only applicable to restaurants.
AllowsGroups Boolean Whether the restaurant accommodates groups. Only applicable to restaurants.
AllowsKids Boolean Whether the restaurant allows kids. Only applicable to restaurants.
ProvidesTakeout Boolean Whether the restaurant provides a takeout service. Only applicable to restaurants.
ProvidesDelivery Boolean Whether the restaurant provides a delivery service. Only applicable to restaurants.
ProvidesCatering Boolean Whether the restaurant provides a catering service. Only applicable to restaurants.
HasWaiters Boolean Whether the restaurant has waiters. Only applicable to restaurants.
HasOutdoorSeating Boolean Whether the restaurant has outdoor seating. Only applicable to restaurants.
ServesBreakfast Boolean Whether the restaurant serves breakfast. Only applicable to restaurants.
ServesLunch Boolean Whether the restaurant serves lunch. Only applicable to restaurants.
ServesDinner Boolean Whether the restaurant serves dinner. Only applicable to restaurants.
ServesCoffee Boolean Whether the restaurant serves coffee. Only applicable to restaurants.
ServesDrinks Boolean Whether the restaurant serves drinks. Only applicable to restaurants.
CulinaryTeam String Culinary team of the business. Applicable to restaurants or nightlife.
PharmaSafetyInfo String Pharmacy safety information. Applicable to pharmaceutical companies.
Affiliation String Affiliation of this person. Applicable to pages representing people.
Birthday String Birthday of this person. Applicable to pages representing people.
PersonalInfo String Personal information. Applicable to pages representing people.
PersonalInterests String Personal interests. Applicable to pages representing people.
ArtistsWeLike String Artists the band likes. Applicable to bands.
BandInterests String Band interests. Applicable to bands.
BandMembers String Members of the band. Applicable to bands.
Bio String Biography of the band. Applicable to bands.
BookingAgent String Booking agent of the band. Applicable to bands.
GeneralManager String General manager of the business. Applicable to restaurants or nightlife. Applicable to bands.
Hometown String Hometown of the band. Applicable to bands.
PressContact String Press contact information of the band. Applicable to bands.
RecordLabel String Record label of the band. Applicable to bands.
Awards String Awards information for the film or TV show. Applicable to films and TV shows.
DirectedBy String The director of the film or TV show. Applicable to films and TV shows.
Genre String The genre of the film or TV show. Applicable to films and TV shows.
Influences String Influences on the band. Applicable to bands.
PlotOutline String The plot outline of the film or TV show. Applicable to films and TV shows.
ProducedBy String The productor of the film. Applicable to films.
ReleaseData String The film's release data. Applicable to films and TV shows.
ScreenplayBy String The screenwriter of the film. Applicable to films and TV shows.
Starring String The cast of the film or TV show. Applicable to films and TV shows.
Studio String The studio for the film production. Applicable to films.
Network String The network the TV show airs on. Applicable to TV shows.
Schedule String The air schedule of the TV show. Applicable to TV shows.
Season String The current season of the TV show. Applicable to TV shows.
WrittenBy String The writer of the TV show. Applicable to TV shows.
Built String The information about when the vehicle was built. Applicable to vehicles.
Features String Features of the vehicle. Applicable to vehicles.
MPG String Miles per gallon for the vehicle. Applicable to vehicles.
Members String Members of this org. Applicable to pages representing team orgs.
InstagramBusinessAccountId String The business instagram account id associated with this page.

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. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Permissions

Query the Permissions the User has granted the current application.

Columns

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

Facebook Connector for CData Sync

Photos

Query Photos associated with a Target. Accessing Photo information typically requires the user_photos permission.

Table Specific Information

Photos in Facebook are photos that are uploaded by a user (for example, to a page) and are part of a photo album.

Note: Due to a deprecation in the Facebook API, queries to the Comments, Photos, Posts, and Videos views where a user profile is either the defined or default target, no longer return data for the following fields:

  • comments
  • message_tags
  • reactions
  • sharedposts
  • story
  • story_tags
  • to
  • via
For further information, see https://developers.facebook.com/docs/graph-api/changelog/version16.0.

Select

When querying photos, specify a target. The target represents the user, page, album, or event that photos are being retrieved for. For example:

SELECT * FROM Photos WHERE Target = 'facebook'

If no target is specified, the currently authenticated user will be used as the target.

When querying photos, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Photos WHERE Target = 'mytarget' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '10/1/2012'

Columns

Name Type Description
ID [KEY] String The Id of the photo.
Target String The Id or username of the target you are retrieving posts for or are posting to. This may be an album, event, page, or user.
FromId String Id of the user who uploaded the photo.
FromName String Name of the user who uploaded the photo.
FromPicture String Photo of the user who uploaded the photo.
FromCategory String Category of the user who uploaded the photo. FromCategory may only be retrieved if the other From* fields are not selected.
Link String A link to the photo on Facebook.
Name String The name of the photo.
Picture String A link a thumbnail of the photo.
Source String The source image of the photo.
Height Integer The height of the photo.
Width Integer The width of the photo.
Position Integer The position of the photo in the album.
Icon String A link to the icon Facebook displays when photos are published to the stream.
PlaceId String The Id of the location associated with the post, if any.
PlaceName String The name of the location associated with the post, if any.
Images String An aggregate of four different images for the photo.
CommentsCount Integer The number of comments for the photo.
LikesCount Integer The number of times the photo has been liked.
CommentsData String An aggregate of comments for this photo.
LikesData String An aggregate of likes data.
CreatedTime Datetime When the photo was uploaded.
UpdatedTime Datetime When the photo was last updated.

Facebook Connector for CData Sync

Places

Query the Places based on the supplied Id. Places are stored as Pages in Facebook.

Table Specific Information

Places in Facebook are places that can charted on a map and visited. They will typically contain an address, coordinates, and basic information.

Select

If you know the place Id, you may specify the Id to obtain information about the specific place. For example:

SELECT * FROM Places WHERE Id = '407032649344593'

If no Id is specified, no results will come back.

Columns

Name Type Description
ID [KEY] String The Id of the place.
Username String Username for the page of the place if any.
Name String The name of the place.
Category String The category of the place.
Categories String An aggregate of categories associated with the page if multiple categories are available.
Link String A link to the place.
LocationStreet String The street address of the place.
LocationCity String The the city for the place.
LocationState String The the state for the place.
LocationCountry String The the country for the place.
LocationZip String The the ZIP code of the place.
LocationLatitude String The latitude of the place.
LocationLongitude String The longitude of the place.
Phone String The phone number of the place, if available.
Picture String A link to the profile picture of the page for the place.
About String Basic information about the place.
Description String A description of the place, if available.
Website String A link to the website for the place.
Likes Integer Number of people who like the place.
Checkins Integer The total number of users who have checked in to the place.
TalkingAboutCount Integer The number of users talking about the place.
CanPost Boolean Boolean indicating if the authenticated user can post of the page for the place.
IsPublished Boolean A boolean indicating if the page for the place has been published.
IsCommunityPage Boolean Boolean indicating if this is a community Page.
PublicTransit String The public transit available for the place, if any.
ParkingStreet Boolean Boolean indicating if street parking is available.
ParkingLot Boolean Boolean indicating if a parking lot is available.
ParkingValet Boolean Boolean indicating if valet parking is available.

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. For more information, see the WHERE clause section.

Name Type Description
Distance String Optional input that can be specified if searching places. This is the maximum distance from the specified LocationLatitude and LocationLongitude in meters.
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

PostSponsorTags

Query the Pages that have sponsored a target post. This table requires authentication, and the Post Id must be specified as the Target.

Columns

Name Type Description
ID [KEY] String The Id of the post.
Description String A description of the page, if available.
Founded String When the company was founded.
GeneralInfo String General information about the page.
About String Basic information about the page.
Name String The name of the page.
Category String The category of the page.
FanCount Integer The number of fans of the page.
Link String A link to the page.
LocationCity String The city for the page.
LocationCountry String The country for the page.
TalkingAboutCount Integer The number of users talking about the page.
Target String ID of the post that has sponsored the pages.

Facebook Connector for CData Sync

Ratings

List of ratings for a Facebook Page. This view requires authentication.

Columns

Name Type Description
Target String The Id or name of the page to retrieve ratings for.
CreatedTime Datetime When the reviewer rated this object.
HasRating Boolean Bolean indicating if there was a rating included? (1-5 stars).
HasReview Boolean Bolean indicating if there was text in the rating.
OpenGraphID String Id of Open Graph story generated by the rating action.
Rating Integer Rating (1-5 stars).
ReviewText String The time the last message was posted in the conversation.
ReviewerID String Person who rated the object.
ReviewerName String Person who rated the object.

Facebook Connector for CData Sync

SimpleVideoInsights

Allows the retrieval of simple video insights with a single value in the response.

Table Specific Information

Simple video insights refers to simple insights that can be retrieved from a video. These kinds of insights have a single value in the response and can only be filtered by a few values.

Select

When selecting simple video insights, a Target must be specified. In addition, an InsightName should always be specified. For instance:

SELECT * FROM SimpleVideoInsights WHERE Target = 'myvideoid' AND InsightName = 'TOTAL_VIDEO_VIEWS'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Breakdowns in smaller units are not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Value Long Insight column for a singular value response.
Target String The target of the insight. This must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: TOTAL_VIDEO_VIEWS, TOTAL_VIDEO_VIEWS_UNIQUE, TOTAL_VIDEO_VIEWS_AUTOPLAYED, TOTAL_VIDEO_VIEWS_CLICKED_TO_PLAY, TOTAL_VIDEO_VIEWS_SOUND_ON, TOTAL_VIDEO_COMPLETE_VIEWS, TOTAL_VIDEO_COMPLETE_VIEWS_UNIQUE, TOTAL_VIDEO_COMPLETE_VIEWS_AUTO_PLAYED, TOTAL_VIDEO_COMPLETE_VIEWS_CLICKED_TO_PLAY, TOTAL_VIDEO_10S_VIEWS, TOTAL_VIDEO_10S_VIEWS_UNIQUE, TOTAL_VIDEO_10S_VIEWS_auto_played, TOTAL_VIDEO_10S_VIEWS_CLICKED_TO_PLAY, TOTAL_VIDEO_10S_VIEWS_SOUND_ON, TOTAL_VIDEO_AVG_TIME_WATCHED, TOTAL_VIDEO_VIEW_TOTAL_TIME, TOTAL_VIDEO_IMPRESSIONS, TOTAL_VIDEO_IMPRESSIONS_UNIQUE, TOTAL_VIDEO_IMPRESSIONS_VIRAL_UNIQUE, TOTAL_VIDEO_IMPRESSIONS_VIRAL, TOTAL_VIDEO_IMPRESSIONS_FAN_UNIQUE, TOTAL_VIDEO_IMPRESSIONS_FAN

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

StoryAttachments

Query attachments from a post or comment.

Table Specific Information

StoryAttachments in Facebook are attachments associated with a particular user or page story, like a page post or comment.

Select

When querying StoryAttachments, the Target must be specified and set to that of a post or comment. For example, to retrieve all the attachments for a specific post, your SELECT statement could look something like this:

SELECT * FROM StoryAttachments WHERE Target = '15526475270_410830705612736'

Columns

Name Type Description
Target String The Id or username of the target you are retrieving the wall for.
Type String The type of post.
Link String The link attached to the post.
Name String The name of the link.
Caption String The caption of the link, which appears beneath the link name.
Description String A description of the link, appears beneath the link caption.
Source String A URL to a flash movie or video file embedded within the post.
ObjectId String The Facebook object Id for an uploaded photo or video.

Facebook Connector for CData Sync

TaggedBy

Query information about Posts, Statuses, Photos, and other entities that have tagged the User or Page. This view is a derivative of the Wall connection where only entries that have tagged the Target User or Page will be returned. In general it is only available for Pages.

Columns

Name Type Description
ID [KEY] String The Id of the entity that has tagged the user or page.
Target String The Id or username of the user you are retrieving from.
FromId String Id of the user who made the post.
FromName String Name of the user who made the post.
FromPicture String Picture of the user who made the post.
Message String The message of the post or status if available.
CommentsCount Integer The number of comments for the post.
LikesCount Integer The number of times the post has been liked.
SharesCount Integer The number of times the post has been shared.
CreatedTime Datetime When the post was created.
UpdatedTime Datetime When the post was last updated.

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. For more information, see the WHERE clause section.

Name Type Description
offset String Which result to begin returning results from. Used for manual paging of results.

Facebook Connector for CData Sync

Users

Returns basic information about the authenticated user.

Table Specific Information

Users in Facebook are the various user accounts on Facebook.

Select

When selecting users, an Id must be specified. For example:

SELECT * FROM Posts WHERE Id = 'UserId'

If an Id is not specified, the information for the currently logged in user will be returned.

Columns

Name Type Description
ID [KEY] String The Id of the user.
Name String The full name of the user.
Picture String Picture of the user.
FirstName String The first name of the user.
MiddleName String The middle name of the user.
LastName String The last name of the user.
Birthday String The birthday of the user. Requires the user_birthday permission.
Email String The email address of the user. Requires the email permission.
HometownName String The hometown name of the user. Requires the user_hometown permission.
HometownId String The hometown name of the user. Requires the user_hometown permission.
LocationName String The current city name of the user. Requires the user_location permission.
LocationId String The current city Id of the user. Requires the user_location permission.

Facebook Connector for CData Sync

VideoInsightsByActionType

Allows the retrieval of video insights by story action type.

Table Specific Information

Video insights by action type refers to video insights that can be retrieved that detail totals for types of stories.

Select

When selecting video insights, a Target must be specified.

SELECT * FROM VideoInsightsByActionType WHERE Target = 'myvideoid'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Like Long Total likes.
Comment Long Total comments.
Share Long Total shares.
Target String The target of the insight. This is a video and 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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

VideoInsightsByDistributionType

Allows the retrieval of video insights by distribution type.

Table Specific Information

Video insights by reaction type refers to video insights that offer information on views your video got from different distribution sources.

Select

When selecting video insights, a Target must be specified. In addition, an InsightName should always be specified. For instance:

SELECT * FROM VideoInsightsByDistributionType WHERE Target = 'myvideoid' AND InsightName = 'TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Page_Owned Long Views that were owned by the page.
Shared Long Views coming from shares.
Crossposted Long Views coming from posts that were crossposted.
Target String The target of the insight. This is a video and must always be specified.
InsightName String The name of the insight. This must always be specified. The available values are: TOTAL_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE,TOTAL_VIDEO_VIEW_TIME_BY_DISTRIBUTION_TYPE

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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

VideoInsightsByReactionType

Allows the retrieval of video insights by reaction type.

Table Specific Information

Video insights by reaction type refers to video insights that can be measured by the type of reaction.

Select

When selecting video insights, a Target must be specified. For instance:

SELECT * FROM VideoInsightsByReactionType WHERE Target = 'myvideoid'

Note: Unlike other types of insights, video insights are only available for the entire lifetime of the video. Separation into smaller units is not possible.

Columns

Name Type Description
RowNumber [KEY] Int The row number of the result.
Like Long Total like reactions.
Love Long Total love reactions.
Wow Long Total wow reactions.
Haha Long Total haha reactions.
Sorry Long Total sorry reactions.
Anger Long Total anger reactions.
Target String The target of the insight. This is a video and 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. For more information, see the WHERE clause section.

Name Type Description
FromDateTime String The earliest time for insight data to have been collected.
ToDateTime String The latest time for insight data to have been collected.

Facebook Connector for CData Sync

VideoReels

Query reels for a given page.

Columns

Name Type Description
ID [KEY] String The Id of the video.
Target String The Id or username of the target you are retrieving videos for.
Description String A description of the video.
Published [KEY] Boolean Whether a post about this reel is published.
VideoStatus [KEY] String Status attributes of a video.
UploadingPhaseStatus [KEY] String Status attributes of a video.
ProcessingPhaseStatus [KEY] String Status attributes of a video.
PublishingPhaseStatus [KEY] String Status attributes of a video.
PublishingPhasePublishStatus [KEY] String Status attributes of a video.
PublishingPhasePublishTime [KEY] String Status attributes of a video.
Title [KEY] String The video title or caption.
Views [KEY] Long The public view count of the video.
Place [KEY] String Place info.
PrivacyAllow [KEY] String Privacy setting for the video.
PrivacyDeny [KEY] String Privacy setting for the video.
PrivacyDescription [KEY] String Privacy setting for the video.
PrivacyFriends [KEY] String Privacy setting for the video.
PrivacyNetworks [KEY] String Privacy setting for the video.
PrivacyValue [KEY] String Privacy setting for the video.
FromId String The Id of the user who uploaded the video.
FromName String The name of the user who uploaded the video.
FromPicture String The picture of the user who uploaded the video.
FromCategory String The category of the user who uploaded the video. FromCategory may only be retrieved if the other From* fields are not selected.
Picture String The URL for the thumbnail of the video.
Source String The URL to the raw, playable video file.
EmbedHtml String The HTML element that may be embedded in a Web page to play the video.
Icon String The icon that Facebook displays when videos are published to the Feed.
Format String An aggregate of four different formats for the video.
Tags String An aggregate of users tagged in the video, if any.
CommentsCount Integer The number of comments for the video.
LikesCount Integer The number of times the video has been liked.
CommentsData String An aggregate of comments for the video.
CreatedTime Datetime When the video was uploaded.
UpdatedTime Datetime When the video was last updated.

Facebook Connector for CData Sync

Videos

Query Videos from a Target. Normally requires the user_videos permission.

Table Specific Information

Videos in Facebook are videos that have been uploaded by a user or to a page on Facebook.

Note: Due to a deprecation in the Facebook API, queries to the Comments, Photos, Posts, and Videos views where a user profile is either the defined or default target, no longer return data for the following fields:

  • comments
  • message_tags
  • reactions
  • sharedposts
  • story
  • story_tags
  • to
  • via
For further information, see https://developers.facebook.com/docs/graph-api/changelog/version16.0.

Select

When selecting videos, specify a target. The target represents the user or page who uploaded the video. If no target is specified, the currently authenticated user will be used as the target. For example:

SELECT * FROM Videos WHERE Target = 'facebook'

If you know the Id, you can specify the Id to obtain information about the specific video. For example:

SELECT * FROM Videos WHERE Id = 'VideoId'

When querying videos, retrieve elements by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Videos WHERE Target = 'mytarget' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '10/1/2012'

Columns

Name Type Description
ID [KEY] String The Id of the video.
Target String The Id or username of the target you are retrieving videos for.
FromId String The Id of the user who uploaded the video.
FromName String The name of the user who uploaded the video.
FromPicture String The picture of the user who uploaded the video.
FromCategory String The category of the user who uploaded the video. FromCategory may only be retrieved if the other From* fields are not selected.
Description String A description of the video.
Picture String The URL for the thumbnail of the video.
Source String The URL to the raw, playable video file.
EmbedHtml String The HTML element that may be embedded in a Web page to play the video.
Icon String The icon that Facebook displays when videos are published to the Feed.
Format String An aggregate of four different formats for the video.
TagsData String An aggregate of users tagged in the video, if any.
CommentsCount Integer The number of comments for the video.
LikesCount Integer The number of times the video has been liked.
CommentsData String An aggregate of comments for the video.
CreatedTime Datetime When the video was uploaded.
UpdatedTime Datetime When the video was last updated.

Facebook Connector for CData Sync

Wall

Query Posts from the Wall of a Target.

Table Specific Information

Walls in Facebook are a collection of the various posts and updates made to a user's profile or wall.

Select

When selecting from a wall, specify a target. The target represents the user, page, application, or other valid entity that may have a wall associated with it. If no target is specified, the currently authenticated user will be used as the target. For example:

SELECT * FROM Wall WHERE Target = 'facebook'

When querying the wall, elements may be retrieved by specifying either the CreatedTime or the UpdatedTime. For example:

SELECT * FROM Wall WHERE Target = 'facebook' AND CreatedTime >= '1/1/2012' AND CreatedTime <= '2/1/2012'

INSERT

While the wall may not be directly inserted to, you may post to a wall by issuing an INSERT with the correct target using the Posts table.

Columns

Name Type Description
ID [KEY] String The Id of the post.
Target String The Id or username of the target you are retrieving the wall for.
FromId String Id of the user who made the post.
FromName String Name of the user who made the post.
FromPicture String Picture of the user who made the comment.
FromCategory String Category of the user who made the post. FromCategory may only be retrieved if the other From* fields are not selected.
ToData String An aggregate of users the post was made to.
Message String The message of the post.
MessageTags String An aggregate of objects tagged in the message such as Users, Pages, etc.
Picture String A link to the picture included in the post.
Icon String Link to an icon representing the type of post.
Actions String An aggregate of available actions on the post (such as commenting or liking).
CommentsCount Integer The number of comments for the post.
LikesCount Integer The number of times the post has been liked.
SharesCount Integer The number of times the post has been shared.
PlaceId String The Id of the location associated with the post, if any.
PlaceName String The name of the location associated with the post, if any.
Attachments String An aggregate for the attachments of the post.
ApplicationId String Id of the application this post came from.
ApplicationNamespace String Information about the application used to create the entity.
Story String Text of stories not intentionally generated by users, such as those generated when two users become friends; you must have the 'Include recent activity stories' migration enabled in your app to retrieve these stories.
StoryTags String An aggregate of objects (users, pages, etc.) associated with the story.
LikesData String An aggregate of like data.
CommentsData String An aggregate of comments for this post.
CreatedTime Datetime When the post was created.
UpdatedTime Datetime When the post was last updated.

Facebook 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
AuthenticateAsPageThe Id of a page to authenticate as when making requests to Facebook.

OAuth


PropertyDescription
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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.
ScopeThe scope to use when authenticating to Facebook.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe 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.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
AggregateFormatThe format aggregate or collection columns should return in.
IgnorePermissionErrorsOn reads of data from Facebook, ignore errors about missing permissions.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeThe maximum number of results to return per page from Facebook.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TargetA default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
TimeoutSpecifies 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.
UploadLinkedMediaUpload linked photos or videos before inserting a new Post.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Facebook 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
AuthenticateAsPageThe Id of a page to authenticate as when making requests to Facebook.
Facebook Connector for CData Sync

AuthenticateAsPage

The Id of a page to authenticate as when making requests to Facebook.

Remarks

The Id of a page to retrieve data from. The page must be managed by the authenticated user; you can obtain the Ids for all such pages by querying the Pages view.

Facebook 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
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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.
ScopeThe scope to use when authenticating to Facebook.
Facebook Connector for CData Sync

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.

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.

Facebook Connector for CData Sync

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.

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.

Facebook Connector for CData Sync

Scope

The scope to use when authenticating to Facebook.

Remarks

The scope that are used when authenticating to Facebook give your App access to request additional information that may be required for certain tables. Individual scope may be entered in a comma separated list. Leaving it blank will use the defaults. The Scope is only used if you have specified your own OAuthClientId and OAuthClientSecret.

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/. Permissions that may be required depending on your use case are:

user_birthday, user_photos, user_videos, user_likes, user_hometown, user_location, read_insights, pages_manage_metadata, pages_read_engagement, pages_read_user_content, pages_messaging, business_management, instagram_basic, instagram_manage_insights

Facebook 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
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Facebook Connector for CData Sync

SSLServerCert

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.

Facebook 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
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Facebook Connector for CData Sync

FirewallType

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 Facebook. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Facebook. 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 Facebook. 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.

Facebook Connector for CData Sync

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.

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.

Facebook Connector for CData Sync

FirewallPort

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.

Facebook Connector for CData Sync

FirewallUser

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.

Facebook Connector for CData Sync

FirewallPassword

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.

Facebook 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
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe 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.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Facebook Connector for CData Sync

ProxyAutoDetect

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.

Facebook Connector for CData Sync

ProxyServer

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.

Facebook Connector for CData Sync

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.

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.

Facebook Connector for CData Sync

ProxyAuthScheme

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.

Facebook Connector for CData Sync

ProxyUser

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.

Facebook Connector for CData Sync

ProxyPassword

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.

Facebook Connector for CData Sync

ProxySSLType

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 :

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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.

Facebook Connector for CData Sync

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.

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.

Facebook 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
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Facebook Connector for CData Sync

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.

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.

Facebook 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
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Facebook Connector for CData Sync

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.

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\\Facebook 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

Facebook Connector for CData Sync

BrowsableSchemas

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.

Facebook Connector for CData Sync

Tables

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.

Facebook Connector for CData Sync

Views

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.

Facebook 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
AggregateFormatThe format aggregate or collection columns should return in.
IgnorePermissionErrorsOn reads of data from Facebook, ignore errors about missing permissions.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeThe maximum number of results to return per page from Facebook.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TargetA default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
TimeoutSpecifies 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.
UploadLinkedMediaUpload linked photos or videos before inserting a new Post.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Facebook Connector for CData Sync

AggregateFormat

The format aggregate or collection columns should return in.

Remarks

The format aggregate or collection columns should return in.

Facebook Connector for CData Sync

IgnorePermissionErrors

On reads of data from Facebook, ignore errors about missing permissions.

Remarks

This property is disabled by default. While it may help temporarily avoid issues with workflows, permanent resolution of permssions errors is encouraged.

Facebook Connector for CData Sync

MaxRows

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.

Facebook Connector for CData Sync

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.

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

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.

Facebook Connector for CData Sync

Pagesize

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

Remarks

The Pagesize property affects the maximum number of results to return per page from Facebook. Sometimes you may get an error asking you to request less data. The frequency of such errors can be reduced by reducing the pagesize. The maximum pagesize tends to be about 100 per page.

Facebook Connector for CData Sync

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.

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: "*=*"

Facebook Connector for CData Sync

Target

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

Remarks

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

Facebook Connector for CData Sync

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.

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.

Facebook Connector for CData Sync

UploadLinkedMedia

Upload linked photos or videos before inserting a new Post.

Remarks

The UploadLinkedMedia determines whether to upload media before inserting a Post. If set to True, when you attempt to insert a new Post with the Link column, the driver will first attempt to resolve the URL and determine if the URL is referencing a photo or a video. If so, the photo or video will be uploaded first, then a new Post containing the media will be created. If False, then the new Post will be created as a Link Post.

Facebook Connector for CData Sync

UserDefinedViews

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175