Getting Started

This page provides a guide to Establishing a Connection to Facebook in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Facebook

Establishing a Connection shows how to authenticate to Facebook and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Facebook through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Facebook by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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 Cloud 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 name or 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:

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.
Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
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.

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 Cloud 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.
Configure the Cloud 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.

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.
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.
Call the GetOAuthAuthorizationURL stored procedure with the CallbackURI input parameter set to the exact Redirect URI you specified in your application settings.
Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
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 Cloud on another machine, authenticate, and then transfer the resulting OAuth values:

On a second machine, install the Cloud 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.
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 Cloud to enable the automatic refreshing of the access token.

Requesting Additional Permissions

You may find while using the Cloud 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.

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

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	-

Datamodel Permissions

See Data Model for how the Cloud 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 Cloud.

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 Cloud 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 Cloud 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

SSL Configuration

Customizing the SSL Configuration

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

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

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

Data Model

The CData Cloud 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.

Tables

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

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

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.

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, group, 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.

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.

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.

CData Cloud - Facebook 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.
Groups	Query the Pages based on the supplied 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.
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.
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.
Videos	Query Videos from a Target. Normally requires the user_videos permission.
Wall	Query Posts from the Wall of a Target.

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.

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.

Groups

Query the Pages based on the supplied Id.

Table Specific Information

Groups are a place to communicate about shared interests with certain people. Groups may be queried by Id.

Select

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

SELECT * FROM Groups WHERE Id = 'GroupId'

Columns


Name	Type	Description
ID [KEY]	String	The Group ID.
Name	String	The name of the Group.
Description	String	A brief description of the Group.
Email	String	The email address to upload content to the Group. Only current members of the Group can use this.
Icon	String	The URL for the Group's icon.
MemberCount	Integer	The number of members in the Group.
MemberRequestCount	Integer	The number of members in the Group.
CoverId	String	Id of the cover image for the group.
CoverSource	String	The URL to the cover image for the group.
CoverOffsetY	String	The y-axis offset of the cover image for the group.
CoverOffsetX	String	The x-axis offset of the cover image for the group.
Permissions	String	The permissions a User has granted for an app installed in the Group.
Privacy	String	The privacy setting of the Group. Possible values are CLOSED, OPEN, and SECRET. Requires an access token of an Admin of the Group.
UpdatedTime	Datetime	The last time the Group was updated (includes changes Group properties, Posts, and Comments). Requires an access token of an Admin of the Group.

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.

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.

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.

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

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.

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.

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.

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.

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, an InsightName, and a Period. 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 must always be specified. 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_CONSUMPTIONS, PAGE_CONSUMPTIONS_UNIQUE, PAGE_ENGAGED_USERS, PAGE_FAN_ADDS, PAGE_FAN_ADDS_UNIQUE, PAGE_FAN_REMOVES, PAGE_FAN_REMOVES_UNIQUE, PAGE_FANS, PAGE_FANS_ONLINE, PAGE_FANS_ONLINE_PER_DAY, PAGE_IMPRESSIONS, PAGE_IMPRESSIONS_FREQUENCY_DISTRIBUTION, PAGE_IMPRESSIONS_ORGANIC, PAGE_IMPRESSIONS_ORGANIC_UNIQUE, PAGE_IMPRESSIONS_PAID, PAGE_IMPRESSIONS_PAID_UNIQUE, PAGE_IMPRESSIONS_UNIQUE, PAGE_IMPRESSIONS_VIRAL, PAGE_IMPRESSIONS_VIRAL_FREQUENCY_DISTRIBUTION, PAGE_IMPRESSIONS_VIRAL_UNIQUE, PAGE_IMPRESSIONS_NONVIRAL, PAGE_IMPRESSIONS_NONVIRAL_UNIQUE, PAGE_NEGATIVE_FEEDBACK, PAGE_NEGATIVE_FEEDBACK_UNIQUE, PAGE_PLACES_CHECKIN_MOBILE, PAGE_PLACES_CHECKIN_MOBILE_UNIQUE, PAGE_PLACES_CHECKIN_TOTAL, PAGE_PLACES_CHECKIN_TOTAL_UNIQUE, PAGE_POST_ENGAGEMENTS, PAGE_POSTS_IMPRESSIONS, PAGE_POSTS_IMPRESSIONS_ORGANIC, PAGE_POSTS_IMPRESSIONS_ORGANIC_UNIQUE, PAGE_POSTS_IMPRESSIONS_PAID, PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE, PAGE_POSTS_IMPRESSIONS_UNIQUE, PAGE_POSTS_IMPRESSIONS_VIRAL, PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE, PAGE_CONTENT_ACTIVITY, 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, PAGE_VIEWS_LOGGED_IN_TOTAL, PAGE_VIEWS_LOGGED_IN_UNIQUE, PAGE_VIEWS_LOGOUT, PAGE_VIEWS_UNIQUE, POST_CLICKS, POST_CLICKS_UNIQUE, POST_ENGAGED_USERS, POST_IMPRESSIONS, POST_IMPRESSIONS_FAN, POST_IMPRESSIONS_FAN_PAID, POST_IMPRESSIONS_FAN_PAID_UNIQUE, 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_NEGATIVE_FEEDBACK, POST_NEGATIVE_FEEDBACK_UNIQUE, POST_ACTIVITY, POST_ACTIVITY_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_10S, POST_VIDEO_VIEWS_10S_AUTOPLAYED, POST_VIDEO_VIEWS_10S_CLICKED_TO_PLAY, POST_VIDEO_VIEWS_10S_ORGANIC, POST_VIDEO_VIEWS_10S_PAID, POST_VIDEO_VIEWS_10S_SOUND_ON, POST_VIDEO_VIEWS_10S_UNIQUE, 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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	Id of the user who uploaded the video.
FromName	String	Name of the user who uploaded the video.
FromPicture	String	Picture of the user who uploaded the video.
FromCategory	String	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	URL for the thumbnail of the video.
Source	String	A URL to the raw, playable video file.
EmbedHtml	String	The HTML element that may be embedded in an 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.

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, group, 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.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Facebook.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Facebook, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Facebook Stored Procedures


Name	Description
CreateInsightSchema	Creates a schema file for an insight.

CreateInsightSchema

Creates a schema file for an insight.

Input


Name	Type	Description
InsightName	String	The name of the insight to create a table for. The allowed values are PAGE_CONSUMPTIONS, PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE, PAGE_CONSUMPTIONS_BY_CONSUMPTION_TYPE_UNIQUE, PAGE_CONSUMPTIONS_UNIQUE, PAGE_ENGAGED_USERS, PAGE_FAN_ADDS, PAGE_FAN_ADDS_UNIQUE, PAGE_FAN_REMOVES, PAGE_FAN_REMOVES_UNIQUE, PAGE_FANS, PAGE_FANS_BY_LIKE_SOURCE, PAGE_FANS_BY_LIKE_SOURCE_UNIQUE, PAGE_FANS_BY_UNLIKE_SOURCE_UNIQUE, PAGE_FANS_CITY, PAGE_FANS_COUNTRY, PAGE_FANS_GENDER_AGE, PAGE_FANS_LOCALE, PAGE_FANS_ONLINE, PAGE_FANS_ONLINE_PER_DAY, PAGE_IMPRESSIONS, PAGE_IMPRESSIONS_BY_AGE_GENDER_UNIQUE, PAGE_IMPRESSIONS_BY_CITY_UNIQUE, PAGE_IMPRESSIONS_BY_COUNTRY_UNIQUE, PAGE_IMPRESSIONS_BY_LOCALE_UNIQUE, PAGE_IMPRESSIONS_BY_STORY_TYPE, PAGE_IMPRESSIONS_BY_STORY_TYPE_UNIQUE, PAGE_IMPRESSIONS_FREQUENCY_DISTRIBUTION, PAGE_IMPRESSIONS_ORGANIC, PAGE_IMPRESSIONS_ORGANIC_UNIQUE, PAGE_IMPRESSIONS_PAID, PAGE_IMPRESSIONS_PAID_UNIQUE, PAGE_IMPRESSIONS_UNIQUE, PAGE_IMPRESSIONS_VIRAL, PAGE_IMPRESSIONS_VIRAL_FREQUENCY_DISTRIBUTION, PAGE_IMPRESSIONS_VIRAL_UNIQUE, PAGE_NEGATIVE_FEEDBACK, PAGE_NEGATIVE_FEEDBACK_BY_TYPE, PAGE_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE, PAGE_NEGATIVE_FEEDBACK_UNIQUE, PAGE_PLACES_CHECKIN_MOBILE, PAGE_PLACES_CHECKIN_MOBILE_UNIQUE, PAGE_PLACES_CHECKIN_TOTAL, PAGE_PLACES_CHECKIN_TOTAL_UNIQUE, PAGE_PLACES_CHECKINS_BY_AGE_GENDER, PAGE_PLACES_CHECKINS_BY_COUNTRY, PAGE_PLACES_CHECKINS_BY_LOCALE, PAGE_POSITIVE_FEEDBACK_BY_TYPE, PAGE_POSITIVE_FEEDBACK_BY_TYPE_UNIQUE, PAGE_POSTS_IMPRESSIONS, PAGE_POSTS_IMPRESSIONS_FREQUENCY_DISTRIBUTION, PAGE_POSTS_IMPRESSIONS_ORGANIC, PAGE_POSTS_IMPRESSIONS_ORGANIC_UNIQUE, PAGE_POSTS_IMPRESSIONS_PAID, PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE, PAGE_POSTS_IMPRESSIONS_UNIQUE, PAGE_POSTS_IMPRESSIONS_VIRAL, PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE, PAGE_STORIES, PAGE_STORIES_BY_STORY_TYPE, PAGE_STORYTELLERS, PAGE_CONTENT_ACTIVITY_BY_AGE_GENDER_UNIQUE, PAGE_CONTENT_ACTIVITY_BY_CITY_UNIQUE, PAGE_CONTENT_ACTIVITY_BY_COUNTRY_UNIQUE, PAGE_CONTENT_ACTIVITY_BY_LOCALE_UNIQUE, PAGE_STORYTELLERS_BY_STORY_TYPE, PAGE_TAB_VIEWS_LOGIN_TOP, PAGE_TAB_VIEWS_LOGIN_TOP_UNIQUE, PAGE_TAB_VIEWS_LOGOUT_TOP, 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_VIEW_TIME, 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, PAGE_VIEWS_EXTERNAL_REFERRALS, PAGE_VIEWS_LOGIN, PAGE_VIEWS_LOGIN_UNIQUE, PAGE_VIEWS_LOGOUT, PAGE_VIEWS_UNIQUE, POST_CONSUMPTIONS, POST_CONSUMPTIONS_BY_TYPE, POST_CONSUMPTIONS_BY_TYPE_UNIQUE, POST_CONSUMPTIONS_UNIQUE, POST_ENGAGED_USERS, POST_IMPRESSIONS, POST_IMPRESSIONS_BY_STORY_TYPE, POST_IMPRESSIONS_BY_STORY_TYPE_UNIQUE, POST_IMPRESSIONS_FAN, POST_IMPRESSIONS_FAN_PAID, POST_IMPRESSIONS_FAN_PAID_UNIQUE, 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_NEGATIVE_FEEDBACK, POST_NEGATIVE_FEEDBACK_BY_TYPE, POST_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE, POST_NEGATIVE_FEEDBACK_UNIQUE, POST_STORIES, POST_STORIES_BY_ACTION_TYPE, POST_STORYTELLERS, POST_STORYTELLERS_BY_ACTION_TYPE, 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_RETENTION_GRAPH, POST_VIDEO_RETENTION_GRAPH_AUTOPLAYED, POST_VIDEO_RETENTION_GRAPH_CLICKED_TO_PLAY, POST_VIDEO_VIEW_TIME_BY_AGE_BUCKET_AND_GENDER, POST_VIDEO_VIEW_TIME_BY_COUNTRY_ID, POST_VIDEO_VIEW_TIME_BY_DISTRIBUTION_TYPE, POST_VIDEO_VIEW_TIME_BY_REGION_ID, POST_VIDEO_VIEWS_BY_DISTRIBUTION_TYPE, POST_VIDEO_VIEWS_ORGANIC, POST_VIDEO_VIEWS_ORGANIC_UNIQUE, POST_VIDEO_VIEWS_PAID, POST_VIDEO_VIEWS_PAID_UNIQUE.
Target	String	The default target for this insight.
FromDateTime	String	The earliest date and time value for which to return insight data. This will override the Periods input and in some insights is required.
ToDateTime	String	The latest date and time value for which to return insight data. This will override the Periods input and in some insights is required.
Description	String	An optional description for the insight. This will override the description that comes from the data source.

Result Set Columns


Name	Type	Description
Result	String	Returns Success or Failure.
SchemaFile	String	The generated schema file. You will need to set the Location connection property to the folder containing your schema files.
Columns	String	The number of columns found.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Facebook:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Posts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Posts'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Posts table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Posts'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:facebook:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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

Property	Description
AuthenticateAsPage	The name or Id of a page to authenticate as when making requests to Facebook.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	The scope to use when authenticating to Facebook.

SSL

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

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

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

Miscellaneous

Property	Description
AggregateFormat	The format aggregate or collection columns should return in.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Facebook.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Target	A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UploadLinkedMedia	Upload linked photos or videos before inserting a new Post.

Authentication

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

Property	Description
AuthenticateAsPage	The name or Id of a page to authenticate as when making requests to Facebook.

AuthenticateAsPage

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

Data Type

string

Default Value

""

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.

OAuth

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

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	The scope to use when authenticating to Facebook.

Requesting Additional Permissions

You may find while using the Cloud 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

SSL

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

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

SSLServerCert

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

Data Type

string

Default Value

""

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.

Logging

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

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

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

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

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

Miscellaneous

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

Property	Description
AggregateFormat	The format aggregate or collection columns should return in.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Facebook.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Target	A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UploadLinkedMedia	Upload linked photos or videos before inserting a new Post.

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

UploadLinkedMedia

Upload linked photos or videos before inserting a new Post.

Data Type

bool

Default Value

false

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.

Cloud

Facebook - CData Cloud

Overview

Key Features

Getting Started

Connecting to Facebook

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Facebook

Authenticating to Facebook

Web Applications

Headless Machines

Requesting Additional Permissions

AuthenticateAsPage Property

Working With Insights

Recently Removed Insights

Insight Mapping Reference

Create Insight Schema

Page and Post Insights

Insights By Consumption Type

Insights By Feedback Type

Insights By Like Source Type

Insights By Un Like Source Type

Insights By Reaction Totals

Insights By Story Type

Insights By Tab Type

Simple Video Insights

Video Insights By Action Type

Video Insights By Distribution Type

Video Insights By Reaction Type

Datamodel Permissions

Overview

Specific Permissions

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Views

Stored Procedures

Tables

CData Cloud - Facebook Tables

Likes

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Posts

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Views

CData Cloud - Facebook Views

Comments

Table Specific Information

Select

Columns

Pseudo-Columns

Events

Table Specific Information

Select

Columns

Groups

Table Specific Information

Select

Columns

InsightsByConsumptionType

Table Specific Information

Select

Columns