note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.
Objects Supported
| Name | Description |
|---|---|
| Comments | Create, update, delete, and query the Comments for a Target. Comments may also be inserted based on a Target or deleted based on Id. |
| Events | Query the Events for a Target such as a page id. |
| InsightsByConsumptionType | Allows retrieval of insights by consumption type. |
| InsightsByFeedbackType | Allows retrieval of insights by feedback type. |
| InsightsByLikeSourceType | Allows retrieval of insights by like source type. |
| InsightsByReactionTotals | Allows retrieval of insights by like source type. |
| InsightsByStoryType | Allows retrieval of insights by like story type. |
| InsightsByTabType | Allows retrieval of insights by tab type.. |
| InsightsByUnLikeSourceType | Allows retrieval of insights by like source type. |
| InstagramAccountInsights | Allows you to get insights for an Instagram Business Account. Requires the instagram_basic and instagram_manage_insights scopes. |
| 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. |
| PageAndPostInsights | Allows the retrieval of simple insights with a single value in the response. |
| PageLiveVideos | Live videos on a specified page. This table requires authentication, and the pages_read_engagement (or Page Public Content Access feature if you cannot moderate the page) and pages_show_list permissions. The Page Id must be specified as the Target. |
| Pages | Query the Pages based on the supplied Id. |
| Permissions | Query the Permissions the User has granted the current application. |
| Photos | Query Photos associated with a Target. Accessing Photo information typically requires the user_photos permission. |
| Places | Query the Places based on the supplied Id. Places are stored as Pages in Facebook. |
| 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. |
| PostSponsorTags | Query the Pages that have sponsored a target post. This table requires authentication, and the Post Id must be specified as the Target. |
| Ratings | List of ratings for a Facebook Page. This view requires authentication. |
| SimpleVideoInsights | Allows the retrieval of simple video insights with a single value in the response. |
| StoryAttachments | Query attachments from a post or comment. |
| TaggedBy | Query information about Posts, Statuses, Photos, and other entities that have tagged the User or Page. This view is a derivative of the Wall connection where only entries that have tagged the Target User or Page will be returned. In general it is only available for Pages. |
| Users | Returns basic information about the authenticated user. |
| VideoInsightsByActionType | Allows the retrieval of video insights by story action type. |
| VideoInsightsByDistributionType | Allows the retrieval of video insights by distribution type. |
| VideoInsightsByReactionType | Allows the retrieval of video insights by reaction type. |
| VideoReels | Query reels for a given page. |
| Videos | Query Videos from a Target. Normally requires the user_videos permission. |
| Wall | Query Posts from the Wall of a Target. |
Comments
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the comment. | |
| Target | String | False | No | 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 | True | Users.Id | No | Id of the user who made the comment. |
| FromName | String | True | Users.Name | No | Name of the user who made the comment. |
| FromPicture | String | True | No | Picture of the user who made the comment. | |
| Message | String | False | No | The text of the comment. | |
| MessageTags | String | False | No | Aggregate of tags contained in the message. | |
| Likes | Integer | True | No | The number of likes the comment has. | |
| CommentsCount | Integer | True | No | The number of comments in reply to this comment. | |
| LikesData | String | True | No | Aggregate of likes information on the comment. | |
| UserLikes | Boolean | True | No | Boolean indicating if the authenticated user likes the comment. | |
| CanRemove | Boolean | True | No | Boolean indicating if the comment can be removed. | |
| Attachments | String | True | No | An aggregate for the attachments of the post. | |
| CreatedTime | Datetime | True | No | The time the comment was created. | |
| offset | String | False | Yes | Which result to begin returning results from. Used for manual paging of results. |
Events
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | False | No | The Id of the event. | |
| Target | String | False | No | 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 | False | No | The name of the event. | |
| StartTime | Datetime | False | No | The start time of the event. | |
| EndTime | Datetime | False | No | The end time of the event. | |
| Timezone | String | False | No | The time zone the event will take place in. | |
| Description | String | False | No | The description of the event. | |
| Picture | String | True | No | A URL to the picture of the event. | |
| OwnerId | String | True | No | The Id of the user that created the event. | |
| OwnerName | String | True | No | The name of the user that created the event. | |
| OwnerPicture | String | True | No | Picture of the user who created the event. | |
| OwnerCategory | String | True | No | Category of the owner, if available. | |
| Location | String | True | No | The location of the event, if specified. | |
| LocationId | String | True | No | The Id of the location for the event. | |
| LocationStreet | String | True | No | The street address of the event. | |
| LocationCity | String | True | No | The the city for the event. | |
| LocationState | String | True | No | The the state for the event. | |
| LocationCountry | String | True | No | The the country for the event. | |
| LocationZip | String | True | No | The the ZIP code of the event. | |
| LocationLatitude | String | True | No | The latitude of the event. | |
| LocationLongitude | String | True | No | The longitude of the event. | |
| TicketUri | String | True | No | A URL to a location to buy tickets for this event. | |
| UpdatedTime | Datetime | True | No | When the event was last updated. | |
| AttendingCount | Integer | True | No | Number of people attending the event. | |
| DeclinedCount | Integer | True | No | Number of people who declined the event. | |
| InterestedCount | Integer | True | No | Number of people interested in the event. | |
| MaybeCount | Integer | True | No | Number of people who maybe going to the event. | |
| NoreplyCount | Integer | True | No | Number of people who did not reply to the event. |
InsightsByConsumptionType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Datetime | False | No | The most recent date this insight data is relevant for. | |
| VideoPlay | Long | False | No | Insight column indication the total for the stated consumption type. | |
| OtherClicks | Long | False | No | Insight column indication the total for the stated consumption type. | |
| PhotoView | Long | False | No | Insight column indication the total for the stated consumption type. | |
| LinkClicks | Long | False | No | Insight column indication the total for the stated consumption type. | |
| ButtonClicks | Long | False | No | Insight column indication the total for the stated consumption type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | False | No | The period for the insight. This must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InsightsByFeedbackType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| Like | Long | False | No | Insight column indication the total for the positive feedback type. | |
| Comment | Long | False | No | Insight column indication the total for the positive feedback type. | |
| Link | Long | False | No | Insight column indication the total for the positive feedback type. | |
| Answer | Long | False | No | Insight column indication the total for the positive feedback type. | |
| Claim | Long | False | No | Insight column indication the total for the positive feedback type. | |
| Rsvp | Long | False | No | Insight column indication the total for the positive feedback type. | |
| HideAllClicks | Long | False | No | Insight column indication the total for the negative feedback type. | |
| HideClicks | Long | False | No | Insight column indication the total for the negative feedback type. | |
| UnlikePageClicks | Long | False | No | Insight column indication the total for the negative feedback type. | |
| ReportSpamClicks | Long | False | No | Insight column indication the total for the negative feedback type. | |
| XButtonClicks | Long | False | No | Insight column indication the total for the negative feedback type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | False | No | The period for the insight. This must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InsightsByLikeSourceType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| Ads | Long | False | No | Insight column indication the total for the like source type. | |
| NewsFeed | Long | False | No | Insight column indication the total for the like source type. | |
| Other | Long | False | No | Insight column indication the total for the like source type. | |
| PageSuggestions | Long | False | No | Insight column indication the total for the like source type. | |
| RestoredLikesFromReactivatedAccounts | Long | False | No | Insight column indication the total for the like source type. | |
| Search | Long | False | No | Insight column indication the total for the like source type. | |
| YourPage | Long | False | No | Insight column indication the total for the like source type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InsightsByReactionTotals
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| Like | Long | False | No | Total like reactions. | |
| Love | Long | False | No | Total love reactions. | |
| Wow | Long | False | No | Total wow reactions. | |
| Haha | Long | False | No | Total haha reactions. | |
| Sorry | Long | False | No | Total sorry reactions. | |
| Anger | Long | False | No | Total anger reactions. | |
| Thankful | Long | False | No | Total thankful reactions. | |
| Pride | Long | False | No | Total pride reactions. | |
| Care | Long | False | No | Total care reactions. | |
| Fire | Long | False | No | Total fire reactions. | |
| Hundred | Long | False | No | Total hundred reactions. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. | |
| InsightName | String | False | Yes | Insight Name. The available values are: PAGE_ACTIONS_POST_REACTIONS_TOTAL,POST_REACTIONS_BY_TYPE_TOTAL |
InsightsByStoryType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| UserPost | Long | False | No | Insight column indication the total for the stated story type. | |
| PagePost | Long | False | No | Insight column indication the total for the stated story type. | |
| Checkin | Long | False | No | Insight column indication the total for the stated story type. | |
| Fan | Long | False | No | Insight column indication the total for the stated story type. | |
| Question | Long | False | No | Insight column indication the total for the stated story type. | |
| Coupon | Long | False | No | Insight column indication the total for the stated story type. | |
| Event | Long | False | No | Insight column indication the total for the stated story type. | |
| Mention | Long | False | No | Insight column indication the total for the stated story type. | |
| Other | Long | False | No | Insight column indication the total for the stated story type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | False | No | The period for the insight. This must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InsightsByTabType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| About | Long | False | No | Insight column indication the total for the tab type. | |
| Ads | Long | False | No | Insight column indication the total for the tab type. | |
| Album | Long | False | No | Insight column indication the total for the tab type. | |
| AllActivity | Long | False | No | Insight column indication the total for the tab type. | |
| App | Long | False | No | Insight column indication the total for the tab type. | |
| Community | Long | False | No | Insight column indication the total for the tab type. | |
| Events | Long | False | No | Insight column indication the total for the tab type. | |
| Home | Long | False | No | Insight column indication the total for the tab type. | |
| Info | Long | False | No | Insight column indication the total for the tab type. | |
| Insights | Long | False | No | Insight column indication the total for the tab type. | |
| Jobs | Long | False | No | Insight column indication the total for the tab type. | |
| Likes | Long | False | No | Insight column indication the total for the tab type. | |
| Locations | Long | False | No | Insight column indication the total for the tab type. | |
| Notes | Long | False | No | Insight column indication the total for the tab type. | |
| Photos | Long | False | No | Insight column indication the total for the tab type. | |
| PhotosAlbums | Long | False | No | Insight column indication the total for the tab type. | |
| PhotosStream | Long | False | No | Insight column indication the total for the tab type. | |
| Posts | Long | False | No | Insight column indication the total for the tab type. | |
| Profile | Long | False | No | Insight column indication the total for the tab type. | |
| ProfileAbout | Long | False | No | Insight column indication the total for the tab type. | |
| ProfileCommunity | Long | False | No | Insight column indication the total for the tab type. | |
| ProfileHome | Long | False | No | Insight column indication the total for the tab type. | |
| ProfileInfo | Long | False | No | Insight column indication the total for the tab type. | |
| ProfileLikes | Long | False | No | Insight column indication the total for the tab type. | |
| ProfilePhotos | Long | False | No | Insight column indication the total for the tab type. | |
| ProfilePosts | Long | False | No | Insight column indication the total for the tab type. | |
| Reviews | Long | False | No | Insight column indication the total for the tab type. | |
| Timeline | Long | False | No | Insight column indication the total for the tab type. | |
| Videos | Long | False | No | Insight column indication the total for the tab type. | |
| Wall | Long | False | No | Insight column indication the total for the tab type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | False | No | The period for the insight. This must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InsightsByUnLikeSourceType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| DeactivatedOrMemorializedAccountRemovals | Long | False | No | Insight column indication the total for the like source type. | |
| SuspiciousAccountRemovals | Long | False | No | Insight column indication the total for the like source type. | |
| UnlikesFromPagePostsOrNewsFeed | Long | False | No | Insight column indication the total for the like source type. | |
| UnlikesFromSearch | Long | False | No | Insight column indication the total for the like source type. | |
| UnderageAccountRemovals | Long | False | No | Insight column indication the total for the like source type. | |
| UnlikesFromPageSuggestions | Long | False | No | Insight column indication the total for the like source type. | |
| Other | Long | False | No | Insight column indication the total for the like source type. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
InstagramAccountInsights
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | String | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| Value | Long | False | No | Insight column for a singular value response. | |
| Description | String | False | No | 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. | |
| InsightName | String | False | No | 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 | False | No | The values for an insight breakdown. Applies to AUDIENCE_GENDER_AGE, AUDIENCE_COUNTRY, AUDIENCE_CITY. | |
| Period | String | False | No | 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. | |
| Timeframe | String | False | No | 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. | |
| Target | String | False | No | 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. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
Likes
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | 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 | No | 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 | No | The name of the user who likes the target. May alternatively be the name of a page. | |
| Username | String | True | No | The username of a page when retrieving pages a page has liked. | |
| Picture | String | True | No | Picture of the user who likes the target. May alternatively be the picture of a page. | |
| Category | String | True | No | The category of the user or page. | |
| CreatedTime | Datetime | True | No | The time the like was created, if available. | |
| offset | String | False | Yes | Which result to begin returning results from. Used for manual paging of results. |
PageAndPostInsights
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| EndTime | Date | False | No | The most recent date this insight data is relevant for. | |
| Value | Long | False | No | Insight column for a singular value response. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | The name of the insight. This can be specified to improve performance. The available values are: PAGE_ACTIONS_POST_REACTIONS_ANGER_TOTAL, PAGE_ACTIONS_POST_REACTIONS_HAHA_TOTAL, PAGE_ACTIONS_POST_REACTIONS_LIKE_TOTAL, PAGE_ACTIONS_POST_REACTIONS_LOVE_TOTAL, PAGE_ACTIONS_POST_REACTIONS_SORRY_TOTAL, PAGE_ACTIONS_POST_REACTIONS_WOW_TOTAL, PAGE_FAN_ADDS, PAGE_FAN_ADDS_UNIQUE, PAGE_FAN_REMOVES, PAGE_FAN_REMOVES_UNIQUE, PAGE_FANS, PAGE_IMPRESSIONS, PAGE_IMPRESSIONS_PAID, PAGE_IMPRESSIONS_PAID_UNIQUE, PAGE_IMPRESSIONS_UNIQUE, PAGE_IMPRESSIONS_VIRAL, PAGE_IMPRESSIONS_VIRAL_UNIQUE, PAGE_IMPRESSIONS_NONVIRAL, PAGE_IMPRESSIONS_NONVIRAL_UNIQUE, PAGE_POST_ENGAGEMENTS, PAGE_POSTS_IMPRESSIONS, PAGE_POSTS_IMPRESSIONS_PAID, PAGE_POSTS_IMPRESSIONS_PAID_UNIQUE, PAGE_POSTS_IMPRESSIONS_UNIQUE, PAGE_POSTS_IMPRESSIONS_VIRAL, PAGE_POSTS_IMPRESSIONS_VIRAL_UNIQUE, PAGE_VIDEO_COMPLETE_VIEWS_30S, PAGE_VIDEO_COMPLETE_VIEWS_30S_AUTOPLAYED, PAGE_VIDEO_COMPLETE_VIEWS_30S_CLICK_TO_PLAY, PAGE_VIDEO_COMPLETE_VIEWS_30S_ORGANIC, PAGE_VIDEO_COMPLETE_VIEWS_30S_PAID, PAGE_VIDEO_COMPLETE_VIEWS_30S_REPEAT_VIEWS, PAGE_VIDEO_COMPLETE_VIEWS_30S_UNIQUE, PAGE_VIDEO_REPEAT_VIEWS, PAGE_VIDEO_VIEWS, PAGE_VIDEO_VIEWS_AUTOPLAYED, PAGE_VIDEO_VIEWS_CLICK_TO_PLAY, PAGE_VIDEO_VIEWS_ORGANIC, PAGE_VIDEO_VIEWS_PAID, PAGE_VIDEO_VIEWS_UNIQUE, PAGE_VIEWS_TOTAL, POST_CLICKS, POST_IMPRESSIONS, POST_IMPRESSIONS_FAN, POST_IMPRESSIONS_FAN_UNIQUE, POST_IMPRESSIONS_ORGANIC, POST_IMPRESSIONS_ORGANIC_UNIQUE, POST_IMPRESSIONS_PAID, POST_IMPRESSIONS_PAID_UNIQUE, POST_IMPRESSIONS_UNIQUE, POST_IMPRESSIONS_VIRAL, POST_IMPRESSIONS_VIRAL_UNIQUE, POST_VIDEO_AVG_TIME_WATCHED, POST_VIDEO_COMPLETE_VIEWS_ORGANIC, POST_VIDEO_COMPLETE_VIEWS_ORGANIC_UNIQUE, POST_VIDEO_COMPLETE_VIEWS_PAID, POST_VIDEO_COMPLETE_VIEWS_PAID_UNIQUE, POST_VIDEO_LENGTH, POST_VIDEO_VIEW_TIME, POST_VIDEO_VIEW_TIME_ORGANIC, POST_VIDEO_VIEWS_15S, POST_VIDEO_VIEWS_ORGANIC, POST_VIDEO_VIEWS_ORGANIC_UNIQUE, POST_VIDEO_VIEWS_PAID, POST_VIDEO_VIEWS_PAID_UNIQUE, POST_VIDEO_VIEWS_SOUND_ON | |
| Period | String | False | No | 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. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
PageLiveVideos
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the post. | |
| Title | String | True | No | The title of the live video. | |
| Status | String | True | No | The status of the LiveVideo. | |
| StreamUrl | String | True | No | The stream url of the live video. | |
| SecureStreamUrl | String | True | No | The secure stream url of the live video. Check with your encoder whether this is supported before adapting. | |
| EmbedHtml | String | True | No | The embed html of the live video. | |
| BroadcastStartTime | Datetime | True | No | The time the video was initially published. | |
| CreationTime | Datetime | True | No | The creation time of the live video. | |
| DashIngestUrl | String | True | No | The dash ingest stream URL of the live video. | |
| DashPreviewUrl | String | True | No | Preview URL for dash player. | |
| Description | String | True | No | The description of the live video. | |
| FromName | String | True | No | The name of the originator of the live video. | |
| FromId | String | True | No | The id of the originator of the live video. | |
| TargetingAgeMax | Integer | True | No | The maximum age of viewers to target the video toward. | |
| TargetingAgeMin | Integer | True | No | The minimum age of viewers to target the video toward. | |
| TargetingCountries | String | True | No | The countries of viewers to target the video toward. | |
| PermalinkUrl | String | True | No | The permalink URL of this video on Facebook. | |
| VideoId | String | True | No | The Id of the video. | |
| Target | String | True | No | ID of the page of the live videos. |
Pages
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the page. | |
| Username | String | True | No | The username for the page, if any. | |
| Name | String | True | No | The name of the page. | |
| Category | String | True | No | The category of the page. | |
| Categories | String | True | No | An aggregate of categories associated with the page if multiple categories are available. | |
| Link | String | True | No | A link to the page. | |
| Picture | String | True | No | A link to the profile picture of the page for the page. | |
| CoverId | String | True | No | Id of the cover image for the page. | |
| CoverSource | String | True | No | The URL to the cover image for the page. | |
| CoverOffsetY | String | True | No | The y-axis offset of the cover image for the page. | |
| CoverOffsetX | String | True | No | The x-axis offset of the cover image for the page. | |
| About | String | True | No | Basic information about the page. | |
| Description | String | True | No | A description of the page, if available. | |
| GeneralInfo | String | True | No | General information provided by the page. | |
| LocationStreet | String | True | No | The street address of the page. | |
| LocationCity | String | True | No | The city for the page. | |
| LocationState | String | True | No | The state for the page. | |
| LocationCountry | String | True | No | The country for the page. | |
| LocationZip | String | True | No | The ZIP code of the page. | |
| LocationLatitude | String | True | No | The latitude of the page. | |
| LocationLongitude | String | True | No | The longitude of the page. | |
| StoreNumber | Integer | True | No | Unique store number for this location page, if applicable. | |
| Phone | String | True | No | The phone number of the page, if available. | |
| Website | String | True | No | A link to the website for the page. | |
| Likes | Integer | True | No | The number of people who like the page. | |
| Checkins | Integer | True | No | The total number of users who have checked in to the place associated with the page. | |
| TalkingAboutCount | Integer | True | No | The number of users talking about the page. | |
| WereHereCount | Integer | True | No | The number of users who were at the location the page is for, if applicable. | |
| CanPost | Boolean | True | No | Boolean indicating if the authenticated user can post of the page for the page. | |
| IsPublished | Boolean | True | No | Boolean indicating if the page for the page has been published. | |
| IsCommunityPage | Boolean | True | No | Boolean indicating if this is a community page. | |
| PublicTransit | String | True | No | The public transit available for the page, if any. | |
| ParkingStreet | Boolean | True | No | Boolean indicating if street parking is available. | |
| ParkingLot | Boolean | True | No | Boolean indicating if a parking lot is available. | |
| ParkingValet | Boolean | True | No | Boolean indicating if valet parking is available. | |
| PromotionEligible | Boolean | True | No | Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page. | |
| PromotionIneligibleReason | String | True | No | Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page. | |
| Founded | String | True | No | When the company is founded. Applicable to companies. | |
| Mission | String | True | No | The company mission. Applicable to companies. | |
| Products | String | True | No | The products of this company. Applicable to companies. | |
| Hours | String | True | No | An aggregate for the hours of operation. Applicable to businesses and places. | |
| Attire | String | True | No | Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified. | |
| AcceptsCashOnly | Boolean | True | No | Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife. | |
| AcceptsVisa | Boolean | True | No | Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife. | |
| AcceptsAmericanExpress | Boolean | True | No | Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife. | |
| AcceptsMasterCard | Boolean | True | No | Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife. | |
| AcceptsDiscover | Boolean | True | No | Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife. | |
| PriceRange | String | True | No | Price range of the business. Applicable to restaurants or nightlife. Valid values are $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+), or Unspecified. | |
| TakesReservations | Boolean | True | No | Whether the restaurant takes reservations. Only applicable to restaurants. | |
| AllowsWalkins | Boolean | True | No | Whether the restaurant allows walk-ins. Only applicable to restaurants. | |
| AllowsGroups | Boolean | True | No | Whether the restaurant accommodates groups. Only applicable to restaurants. | |
| AllowsKids | Boolean | True | No | Whether the restaurant allows kids. Only applicable to restaurants. | |
| ProvidesTakeout | Boolean | True | No | Whether the restaurant provides a takeout service. Only applicable to restaurants. | |
| ProvidesDelivery | Boolean | True | No | Whether the restaurant provides a delivery service. Only applicable to restaurants. | |
| ProvidesCatering | Boolean | True | No | Whether the restaurant provides a catering service. Only applicable to restaurants. | |
| HasWaiters | Boolean | True | No | Whether the restaurant has waiters. Only applicable to restaurants. | |
| HasOutdoorSeating | Boolean | True | No | Whether the restaurant has outdoor seating. Only applicable to restaurants. | |
| ServesBreakfast | Boolean | True | No | Whether the restaurant serves breakfast. Only applicable to restaurants. | |
| ServesLunch | Boolean | True | No | Whether the restaurant serves lunch. Only applicable to restaurants. | |
| ServesDinner | Boolean | True | No | Whether the restaurant serves dinner. Only applicable to restaurants. | |
| ServesCoffee | Boolean | True | No | Whether the restaurant serves coffee. Only applicable to restaurants. | |
| ServesDrinks | Boolean | True | No | Whether the restaurant serves drinks. Only applicable to restaurants. | |
| CulinaryTeam | String | True | No | Culinary team of the business. Applicable to restaurants or nightlife. | |
| PharmaSafetyInfo | String | True | No | Pharmacy safety information. Applicable to pharmaceutical companies. | |
| Affiliation | String | True | No | Affiliation of this person. Applicable to pages representing people. | |
| Birthday | String | True | No | Birthday of this person. Applicable to pages representing people. | |
| PersonalInfo | String | True | No | Personal information. Applicable to pages representing people. | |
| PersonalInterests | String | True | No | Personal interests. Applicable to pages representing people. | |
| ArtistsWeLike | String | True | No | Artists the band likes. Applicable to bands. | |
| BandInterests | String | True | No | Band interests. Applicable to bands. | |
| BandMembers | String | True | No | Members of the band. Applicable to bands. | |
| Bio | String | True | No | Biography of the band. Applicable to bands. | |
| BookingAgent | String | True | No | Booking agent of the band. Applicable to bands. | |
| GeneralManager | String | True | No | General manager of the business. Applicable to restaurants or nightlife. Applicable to bands. | |
| Hometown | String | True | No | Hometown of the band. Applicable to bands. | |
| PressContact | String | True | No | Press contact information of the band. Applicable to bands. | |
| RecordLabel | String | True | No | Record label of the band. Applicable to bands. | |
| Awards | String | True | No | Awards information for the film or TV show. Applicable to films and TV shows. | |
| DirectedBy | String | True | No | The director of the film or TV show. Applicable to films and TV shows. | |
| Genre | String | True | No | The genre of the film or TV show. Applicable to films and TV shows. | |
| Influences | String | True | No | Influences on the band. Applicable to bands. | |
| PlotOutline | String | True | No | The plot outline of the film or TV show. Applicable to films and TV shows. | |
| ProducedBy | String | True | No | The productor of the film. Applicable to films. | |
| ReleaseData | String | True | No | The film's release data. Applicable to films and TV shows. | |
| ScreenplayBy | String | True | No | The screenwriter of the film. Applicable to films and TV shows. | |
| Starring | String | True | No | The cast of the film or TV show. Applicable to films and TV shows. | |
| Studio | String | True | No | The studio for the film production. Applicable to films. | |
| Network | String | True | No | The network the TV show airs on. Applicable to TV shows. | |
| Schedule | String | True | No | The air schedule of the TV show. Applicable to TV shows. | |
| Season | String | True | No | The current season of the TV show. Applicable to TV shows. | |
| WrittenBy | String | True | No | The writer of the TV show. Applicable to TV shows. | |
| Built | String | True | No | The information about when the vehicle was built. Applicable to vehicles. | |
| Features | String | True | No | Features of the vehicle. Applicable to vehicles. | |
| MPG | String | True | No | Miles per gallon for the vehicle. Applicable to vehicles. | |
| Members | String | True | No | Members of this org. Applicable to pages representing team orgs. | |
| InstagramBusinessAccountId | String | True | No | The business instagram account id associated with this page. | |
| offset | String | False | Yes | Which result to begin returning results from. Used for manual paging of results. |
Permissions
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| PermissionName [KEY] | String | True | No | The name of the permission. | |
| Status | String | True | No | The status of the requested permission. |
Photos
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the photo. | |
| Target | String | False | No | 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 | True | No | Id of the user who uploaded the photo. | |
| FromName | String | True | No | Name of the user who uploaded the photo. | |
| FromPicture | String | True | No | Photo of the user who uploaded the photo. | |
| FromCategory | String | True | No | Category of the user who uploaded the photo. FromCategory may only be retrieved if the other From* fields are not selected. | |
| Link | String | False | No | A link to the photo on Facebook. | |
| Name | String | False | No | The name of the photo. | |
| Picture | String | False | No | A link a thumbnail of the photo. | |
| Source | String | True | No | The source image of the photo. | |
| Height | Integer | True | No | The height of the photo. | |
| Width | Integer | True | No | The width of the photo. | |
| Position | Integer | True | No | The position of the photo in the album. | |
| Icon | String | True | No | A link to the icon Facebook displays when photos are published to the stream. | |
| PlaceId | String | False | No | The Id of the location associated with the post, if any. | |
| PlaceName | String | True | No | The name of the location associated with the post, if any. | |
| Images | String | True | No | An aggregate of four different images for the photo. | |
| CommentsCount | Integer | True | No | The number of comments for the photo. | |
| LikesCount | Integer | True | No | The number of times the photo has been liked. | |
| CommentsData | String | True | No | An aggregate of comments for this photo. | |
| LikesData | String | True | No | An aggregate of likes data. | |
| CreatedTime | Datetime | True | No | When the photo was uploaded. | |
| UpdatedTime | Datetime | True | No | When the photo was last updated. |
Places
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the place. | |
| Username | String | True | No | Username for the page of the place if any. | |
| Name | String | True | No | The name of the place. | |
| Category | String | True | No | The category of the place. | |
| Categories | String | True | No | An aggregate of categories associated with the page if multiple categories are available. | |
| Link | String | True | No | A link to the place. | |
| LocationStreet | String | True | No | The street address of the place. | |
| LocationCity | String | True | No | The the city for the place. | |
| LocationState | String | True | No | The the state for the place. | |
| LocationCountry | String | True | No | The the country for the place. | |
| LocationZip | String | True | No | The the ZIP code of the place. | |
| LocationLatitude | String | True | No | The latitude of the place. | |
| LocationLongitude | String | True | No | The longitude of the place. | |
| Phone | String | True | No | The phone number of the place, if available. | |
| Picture | String | True | No | A link to the profile picture of the page for the place. | |
| About | String | True | No | Basic information about the place. | |
| Description | String | True | No | A description of the place, if available. | |
| Website | String | True | No | A link to the website for the place. | |
| Likes | Integer | True | No | Number of people who like the place. | |
| Checkins | Integer | True | No | The total number of users who have checked in to the place. | |
| TalkingAboutCount | Integer | True | No | The number of users talking about the place. | |
| CanPost | Boolean | True | No | Boolean indicating if the authenticated user can post of the page for the place. | |
| IsPublished | Boolean | True | No | A boolean indicating if the page for the place has been published. | |
| IsCommunityPage | Boolean | True | No | Boolean indicating if this is a community Page. | |
| PublicTransit | String | True | No | The public transit available for the place, if any. | |
| ParkingStreet | Boolean | True | No | Boolean indicating if street parking is available. | |
| ParkingLot | Boolean | True | No | Boolean indicating if a parking lot is available. | |
| ParkingValet | Boolean | True | No | Boolean indicating if valet parking is available. | |
| Distance | String | False | Yes | Optional input that can be specified if searching places. This is the maximum distance from the specified LocationLatitude and LocationLongitude in meters. | |
| offset | String | False | Yes | Which result to begin returning results from. Used for manual paging of results. |
Posts
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the post. | |
| Target | String | False | No | The Id or username of the target you are retrieving posts for or are posting to. This can be an event, page, or user. | |
| FromId | String | True | Users.Id | No | Id of the user who made the post. |
| FromName | String | True | Users.Name | No | Name of the user who made the post. |
| FromPicture | String | True | No | Picture of the user who made the post. | |
| FromCategory | String | True | No | Category of the user who made the post. FromCategory can only be retrieved if the other From* fields are not selected. | |
| ToData | String | True | No | An aggregate of users the post was made to. | |
| Message | String | False | No | The message of the post. A message is required when inserting a post. | |
| MessageTags | String | True | No | An aggregate of objects tagged in the message such as users, pages, etc. | |
| Attachments | String | True | No | An aggregate for the attachments of the post. | |
| Picture | String | False | No | A link to the picture included in the post. | |
| FullPicture | String | False | No | A link to the original picture included in the post. The one listed in Picture may be a resized smaller version. | |
| Icon | String | True | No | Link to an icon representing the type of post. | |
| Actions | String | True | No | An aggregate of available actions on the post such as commenting or liking. | |
| CommentsCount | Integer | True | No | The number of comments for the post. | |
| LikesCount | Integer | True | No | The number of times the post has been liked. | |
| SharesCount | Integer | True | No | The number of times the post has been shared. | |
| PlaceId | String | False | No | The Id of the location associated with the post, if any. | |
| PlaceName | String | True | No | The name of the location associated with the post, if any. | |
| ApplicationId | String | True | No | Id of the application this post came from. | |
| ApplicationName | String | True | No | Name of the application this post came from. | |
| ApplicationCanvasName | String | True | No | Information about the application used to create the entity. | |
| ApplicationNamespace | String | True | No | Information about the application used to create the entity. | |
| Story | String | True | No | 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 | No | An aggregate of objects (users, pages, etc.) associated with the story. | |
| LikesData | String | True | No | An aggregate of like data. | |
| CommentsData | String | True | No | An aggregate of comments for this post. | |
| CreatedTime | Datetime | True | No | When the post was created. | |
| UpdatedTime | Datetime | True | No | When the post was last updated. | |
| PermalinkUrl | String | True | No | The permanent static URL to the post on www.facebook.com | |
| TaggedUser | String | False | Yes | 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 | False | Yes | 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 | False | Yes | A link to attach to the post. For use with the creation of posts. For post creation, either Link or Message columns are required. |
PostSponsorTags
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the post. | |
| Description | String | True | No | A description of the page, if available. | |
| Founded | String | True | No | When the company was founded. | |
| GeneralInfo | String | True | No | General information about the page. | |
| About | String | True | No | Basic information about the page. | |
| Name | String | True | No | The name of the page. | |
| Category | String | True | No | The category of the page. | |
| FanCount | Integer | True | No | The number of fans of the page. | |
| Link | String | True | No | A link to the page. | |
| LocationCity | String | True | No | The city for the page. | |
| LocationCountry | String | True | No | The country for the page. | |
| TalkingAboutCount | Integer | True | No | The number of users talking about the page. | |
| Target | String | True | No | ID of the post that has sponsored the pages. |
Ratings
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Target | String | False | No | The Id or name of the page to retrieve ratings for. | |
| CreatedTime | Datetime | False | No | When the reviewer rated this object. | |
| HasRating | Boolean | False | No | Bolean indicating if there was a rating included? (1-5 stars). | |
| HasReview | Boolean | False | No | Bolean indicating if there was text in the rating. | |
| OpenGraphID | String | False | No | Id of Open Graph story generated by the rating action. | |
| Rating | Integer | False | No | Rating (1-5 stars). | |
| ReviewText | String | False | No | The time the last message was posted in the conversation. | |
| ReviewerID | String | False | Users.Id | No | Person who rated the object. |
| ReviewerName | String | False | No | Person who rated the object. |
SimpleVideoInsights
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| Value | Long | False | No | Insight column for a singular value response. | |
| Target | String | False | No | The target of the insight. This must always be specified. | |
| InsightName | String | False | No | 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 | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
StoryAttachments
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Target | String | False | No | The Id or username of the target you are retrieving the wall for. | |
| Type | String | True | No | The type of post. | |
| Link | String | False | No | The link attached to the post. | |
| Name | String | False | No | The name of the link. | |
| Caption | String | False | No | The caption of the link, which appears beneath the link name. | |
| Description | String | False | No | A description of the link, appears beneath the link caption. | |
| Source | String | True | No | A URL to a flash movie or video file embedded within the post. | |
| ObjectId | String | False | No | The Facebook object Id for an uploaded photo or video. |
TaggedBy
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the entity that has tagged the user or page. | |
| Target | String | False | No | The Id or username of the user you are retrieving from. | |
| FromId | String | True | No | Id of the user who made the post. | |
| FromName | String | True | No | Name of the user who made the post. | |
| FromPicture | String | True | No | Picture of the user who made the post. | |
| Message | String | True | No | The message of the post or status if available. | |
| CommentsCount | Integer | True | No | The number of comments for the post. | |
| LikesCount | Integer | True | No | The number of times the post has been liked. | |
| SharesCount | Integer | True | No | The number of times the post has been shared. | |
| CreatedTime | Datetime | True | No | When the post was created. | |
| UpdatedTime | Datetime | True | No | When the post was last updated. | |
| offset | String | False | Yes | Which result to begin returning results from. Used for manual paging of results. |
Users
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the user. | |
| Name | String | False | No | The full name of the user. | |
| Picture | String | True | No | Picture of the user. | |
| FirstName | String | False | No | The first name of the user. | |
| MiddleName | String | False | No | The middle name of the user. | |
| LastName | String | False | No | The last name of the user. | |
| Birthday | String | False | No | The birthday of the user. Requires the user_birthday permission. | |
| String | False | No | The email address of the user. Requires the email permission. | ||
| HometownName | String | False | No | The hometown name of the user. Requires the user_hometown permission. | |
| HometownId | String | False | No | The hometown name of the user. Requires the user_hometown permission. | |
| LocationName | String | False | No | The current city name of the user. Requires the user_location permission. | |
| LocationId | String | False | No | The current city Id of the user. Requires the user_location permission. |
VideoInsightsByActionType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| Like | Long | False | No | Total likes. | |
| Comment | Long | False | No | Total comments. | |
| Share | Long | False | No | Total shares. | |
| Target | String | False | No | The target of the insight. This is a video and must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
VideoInsightsByDistributionType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| Page_Owned | Long | False | No | Views that were owned by the page. | |
| Shared | Long | False | No | Views coming from shares. | |
| Crossposted | Long | False | No | Views coming from posts that were crossposted. | |
| Target | String | False | No | The target of the insight. This is a video and must always be specified. | |
| InsightName | String | False | No | 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 | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
VideoInsightsByReactionType
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| RowNumber [KEY] | Int | False | No | The row number of the result. | |
| Like | Long | False | No | Total like reactions. | |
| Love | Long | False | No | Total love reactions. | |
| Wow | Long | False | No | Total wow reactions. | |
| Haha | Long | False | No | Total haha reactions. | |
| Sorry | Long | False | No | Total sorry reactions. | |
| Anger | Long | False | No | Total anger reactions. | |
| Target | String | False | No | The target of the insight. This is a video and must always be specified. | |
| FromDateTime | String | False | Yes | The earliest time for insight data to have been collected. | |
| ToDateTime | String | False | Yes | The latest time for insight data to have been collected. |
VideoReels
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the video. | |
| Target | String | False | No | The Id or username of the target you are retrieving videos for. | |
| Description | String | True | No | A description of the video. | |
| Published [KEY] | Boolean | True | No | Whether a post about this reel is published. | |
| VideoStatus [KEY] | String | True | No | Status attributes of a video. | |
| UploadingPhaseStatus [KEY] | String | True | No | Status attributes of a video. | |
| ProcessingPhaseStatus [KEY] | String | True | No | Status attributes of a video. | |
| PublishingPhaseStatus [KEY] | String | True | No | Status attributes of a video. | |
| PublishingPhasePublishStatus [KEY] | String | True | No | Status attributes of a video. | |
| PublishingPhasePublishTime [KEY] | String | True | No | Status attributes of a video. | |
| Title [KEY] | String | True | No | The video title or caption. | |
| Views [KEY] | Long | True | No | The public view count of the video. | |
| Place [KEY] | String | True | No | Place info. | |
| PrivacyAllow [KEY] | String | True | No | Privacy setting for the video. | |
| PrivacyDeny [KEY] | String | True | No | Privacy setting for the video. | |
| PrivacyDescription [KEY] | String | True | No | Privacy setting for the video. | |
| PrivacyFriends [KEY] | String | True | No | Privacy setting for the video. | |
| PrivacyNetworks [KEY] | String | True | No | Privacy setting for the video. | |
| PrivacyValue [KEY] | String | True | No | Privacy setting for the video. | |
| FromId | String | True | No | The Id of the user who uploaded the video. | |
| FromName | String | True | No | The name of the user who uploaded the video. | |
| FromPicture | String | True | No | The picture of the user who uploaded the video. | |
| FromCategory | String | True | No | The category of the user who uploaded the video. FromCategory may only be retrieved if the other From* fields are not selected. | |
| Picture | String | False | No | The URL for the thumbnail of the video. | |
| Source | String | True | No | The URL to the raw, playable video file. | |
| EmbedHtml | String | True | No | The HTML element that may be embedded in a Web page to play the video. | |
| Icon | String | True | No | The icon that Facebook displays when videos are published to the Feed. | |
| Format | String | True | No | An aggregate of four different formats for the video. | |
| Tags | String | True | No | An aggregate of users tagged in the video, if any. | |
| CommentsCount | Integer | True | No | The number of comments for the video. | |
| LikesCount | Integer | True | No | The number of times the video has been liked. | |
| CommentsData | String | True | No | An aggregate of comments for the video. | |
| CreatedTime | Datetime | True | No | When the video was uploaded. | |
| UpdatedTime | Datetime | True | No | When the video was last updated. |
Videos
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the video. | |
| Target | String | False | No | The Id or username of the target you are retrieving videos for. | |
| FromId | String | True | No | The Id of the user who uploaded the video. | |
| FromName | String | True | No | The name of the user who uploaded the video. | |
| FromPicture | String | True | No | The picture of the user who uploaded the video. | |
| FromCategory | String | True | No | The category of the user who uploaded the video. FromCategory may only be retrieved if the other From* fields are not selected. | |
| Description | String | True | No | A description of the video. | |
| Picture | String | False | No | The URL for the thumbnail of the video. | |
| Source | String | True | No | The URL to the raw, playable video file. | |
| EmbedHtml | String | True | No | The HTML element that may be embedded in a Web page to play the video. | |
| Icon | String | True | No | The icon that Facebook displays when videos are published to the Feed. | |
| Format | String | True | No | An aggregate of four different formats for the video. | |
| TagsData | String | True | No | An aggregate of users tagged in the video, if any. | |
| CommentsCount | Integer | True | No | The number of comments for the video. | |
| LikesCount | Integer | True | No | The number of times the video has been liked. | |
| CommentsData | String | True | No | An aggregate of comments for the video. | |
| CreatedTime | Datetime | True | No | When the video was uploaded. | |
| UpdatedTime | Datetime | True | No | When the video was last updated. |
Wall
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ID [KEY] | String | True | No | The Id of the post. | |
| Target | String | False | No | The Id or username of the target you are retrieving the wall for. | |
| FromId | String | True | No | Id of the user who made the post. | |
| FromName | String | True | No | Name of the user who made the post. | |
| FromPicture | String | True | No | Picture of the user who made the comment. | |
| FromCategory | String | True | No | Category of the user who made the post. FromCategory may only be retrieved if the other From* fields are not selected. | |
| ToData | String | True | No | An aggregate of users the post was made to. | |
| Message | String | False | No | The message of the post. | |
| MessageTags | String | True | No | An aggregate of objects tagged in the message such as Users, Pages, etc. | |
| Picture | String | False | No | A link to the picture included in the post. | |
| Icon | String | True | No | Link to an icon representing the type of post. | |
| Actions | String | True | No | An aggregate of available actions on the post (such as commenting or liking). | |
| CommentsCount | Integer | True | No | The number of comments for the post. | |
| LikesCount | Integer | True | No | The number of times the post has been liked. | |
| SharesCount | Integer | True | No | The number of times the post has been shared. | |
| PlaceId | String | False | No | The Id of the location associated with the post, if any. | |
| PlaceName | String | True | No | The name of the location associated with the post, if any. | |
| Attachments | String | True | No | An aggregate for the attachments of the post. | |
| ApplicationId | String | True | No | Id of the application this post came from. | |
| ApplicationNamespace | String | True | No | Information about the application used to create the entity. | |
| Story | String | True | No | 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 | True | No | An aggregate of objects (users, pages, etc.) associated with the story. | |
| LikesData | String | True | No | An aggregate of like data. | |
| CommentsData | String | True | No | An aggregate of comments for this post. | |
| CreatedTime | Datetime | True | No | When the post was created. | |
| UpdatedTime | Datetime | True | No | When the post was last updated. |