Total Video Insights Metrics /video-id/video_insights - Documentation

Graph API Version

Insights for Crossposted Videos

Crossposted Videos gives Pages the ability to create posts from videos without re-uploading them again. The major benefit of this is that you can see total insights from all videos crossposted across Facebook and a breakdown of metrics across the multiple posts created from it. You can use video_insights edge on the Video API to read the total insights. This is different from {post_id}/insights since it allows you to read insights from a single post.

All available metrics are shown below.

Name	Description	Values for `period`
`total_video_views`	Total number of times your video was viewed for 3 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_views_unique`	Number of unique people who viewed your video for 3 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_views_autoplayed`	Number of times your video started automatically playing and people viewed it for 3 seconds or viewed it to the end, whichever happened first.	lifetime
`total_video_views_clicked_to_play`	Number of times people clicked to play your video and viewed it for 3 seconds or viewed it to the end, whichever happened first.	lifetime
`total_video_views_organic`	Number of times your video was viewed for 3 seconds or viewed to the end (whichever happened first) without paid promotion.	lifetime
`total_video_views_organic_unique`	Number unique viewers who watched for 3 seconds or viewed to the end (whichever happened first) without paid promotion.	lifetime
`total_video_views_paid`	Number of times your video was viewed for 3 seconds or viewed to the end (whichever happened first) with paid promotion.	lifetime
`total_video_views_paid_unique`	Number of unique viewers who watched for 3 seconds or viewed to the end (whichever happened first) without paid promotion.	lifetime
`total_video_views_sound_on`	Number of times your video was viewed with sound on for 3 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_complete_views`	Number of times your video was viewed for 95% or complete.	lifetime
`total_video_complete_views_unique`	Number of unique viewers who watched for 95% or complete.	lifetime
`total_video_complete_views_auto_played`	Number of times your video started playing automatically and people viewed it for more than 95%.	lifetime
`total_video_complete_views_clicked_to_play`	Number of times people clicked to play your video and viewed it for more than 95%.	lifetime
`total_video_complete_views_organic`	Number of times your video was viewed to 95% of its length without any paid promotion.	lifetime
`total_video_complete_views_organic_unique`	Number of times your video was viewed to 95% of its length without any paid promotion.	lifetime
`total_video_complete_views_paid`	Number of times your video was viewed to 95% of its length after paid promotion.	lifetime
`total_video_complete_views_paid_unique`	Number of times your video was viewed to 95% of its length after paid promotion.	lifetime
`total_video_10s_views`	Total number of times your video was viewed for 10 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_10s_views_unique`	Number of unique people who viewed your video for 10 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_10s_views_auto_played`	Number of times your video started playing automatically and people viewed it for 10 seconds or viewed it to the end, whichever happened first.	lifetime
`total_video_10s_views_clicked_to_play`	Number of times people clicked to play your video and viewed it for 10 seconds or viewed it to the end, whichever happened first.	lifetime
`total_video_10s_views_organic`	Number of times your video was viewed for 10 seconds or viewed to the end, whichever happened first, without a paid promotion.	lifetime
`total_video_10s_views_paid`	Number of times your video was viewed for 10 seconds or viewed to the end, whichever happened first, after a paid promotion.	lifetime
`total_video_10s_views_sound_on`	Number of times your video was viewed with sound on for 10 seconds or viewed to the end, whichever happened first.	lifetime
`total_video_retention_graph`	Views of your video at each moment as a percentage of all views, including views shorter than 3 seconds.	lifetime
`total_video_retention_graph_autoplayed`	Auto-played views of your video at each moment as a percentage of all views, including views shorter than 3 seconds.	lifetime
`total_video_retention_graph_clicked_to_play`	Clicked-to-play views of your video at each moment as a percentage of all views, including views shorter than 3 seconds.	lifetime
`total_video_avg_time_watched`	Average time video was viewed.	lifetime
`total_video_view_total_time`	Total time (in ms) video has been viewed.	lifetime
`total_video_view_total_time_organic`	Total time (in ms) video has been viewed without paid promotion.	lifetime
`total_video_view_total_time_paid`	Total time (in ms) video has been viewed with paid promotion.	lifetime
`total_video_impressions`	The number of impressions of the video.	lifetime
`total_video_impressions_unique`	Number of people your video was served to.	lifetime
`total_video_impressions_paid_unique`	Number of people your advertised Page Video was served to.	lifetime
`total_video_impressions_paid`	Number of impressions of your Page Video in after paid promotion.	lifetime
`total_video_impressions_organic_unique`	Number of people who saw your Page Video without paid promotion.	lifetime
`total_video_impressions_organic`	The number of impressions of your Video without paid promotion.	lifetime
`total_video_impressions_viral_unique`	Number of people who saw your Page Video in a story from a friend.	lifetime
`total_video_impressions_viral`	Number of impressions of your Page Video in a story generated by a friend.	lifetime
`total_video_impressions_fan_unique`	Number of people who saw your Page video because they have liked your Page.	lifetime
`total_video_impressions_fan`	Number of impressions of your Page Video to people who have liked your Page.	lifetime
`total_video_impressions_fan_paid_unique`	Number of people who like your Page and who saw your Page Video in an ad or sponsored story.	lifetime
`total_video_impressions_fan_paid`	Number of paid impressions of your Page Video Asset to people who have liked your Page.	lifetime
`total_video_stories_by_action_type`	Number of stories created about your Page Video, by action type.	lifetime
`total_video_reactions_by_type_total`	The total number of reactions to your post by type.	lifetime
`total_video_view_time_by_age_bucket_and_gender`	Total time (in milliseconds) video has been viewed by Top Audiences.	lifetime
`total_video_view_time_by_region_id`	Total time (in milliseconds) video has been viewed by Top 45 Locations (Region - Country).	lifetime
`total_video_views_by_distribution_type`	Number of times your video was viewed by distribution type (page_owned and shared).	lifetime
`total_video_view_time_by_distribution_type`	Total time (in milliseconds) video has been viewed by distribution type (page_owned, crossposted, shared).	lifetime

Reading

Total insights from all video posts associated with this video.

Graph API Explorer

GET /v2.9/{video-id}/video_insights HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{video-id}/video_insights'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

/* make the API call */
FB.api(
    "/{video-id}/video_insights",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-id}/video_insights",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-id}/video_insights"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps

ads_management

Page management Apps

manage_pages

Other Apps

read_insights

Parameters

Name	Description
`metric` list<A valid metric for an insights endpoint>	The list of metrics that needs to be fetched
`period` enum{day, week, days_28, month, lifetime, total_over_range}	The aggregation period

Fields

Reading from this edge will return a JSON formatted result:

{
    "data": [],
    "paging": {}
}

`data`

A list of InsightsResult nodes.

`paging`

For more details about pagination, see the Graph API guide.

Validation Rules

Error	Description
100	Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.