Video API

Get Insights using the Facebook Video API from Meta

Updated: Jul 19, 2024
Copy for LLM
This guide shows you how to get insights for a video that has been published on a Facebook Page.
Learn more about Reels Insights

Before You Start

You will need:

Limitations

  • Insights for Videos published on Facebook groups or users are not available.
  • A crossposted Video will have its own unique <VIDEO_ID> for each Page it was posted to.

Get Total Insights

Send a GET request to the /<VIDEO_ID>/video_insights endpoint to get total insights from all video posts associated with this video.
GET <API_VERSION>/<VIDEO_ID>/video_insights?access_token=<PAGE_ACCESS_TOKEN>"

EXample Request

curl -X GET \
 "https://graph.facebook.com/v20.0/323790578640877/video_insights?access_token=EAABkW..."

Sample Response

{
  "data": [
    {
      "name": "total_video_views",
      "period": "lifetime",
      "values": [
        {
          "value": 89
        }
      ],
      "title": "Lifetime Total Video Views",
      "description": "Lifetime: Total number of times your video was viewed for 3 seconds or viewed to the end, whichever came first. (Total Count)",
      "id": "323790578640877/video_insights/total_video_views/lifetime"
    },
    {
      "name": "total_video_views_unique",
      "period": "lifetime",
      "values": [
        {
          "value": 56
        }
      ],
      "title": "Lifetime Unique Video Views",
      "description": "Lifetime: Number of unique people who viewed your video for 3 seconds or viewed to the end, whichever came first. (Unique Users)",
      "id": "323790578640877/video_insights/total_video_views_unique/lifetime"
    },
    {
      "name": "total_video_views_autoplayed",
      "period": "lifetime",
      "values": [
        {
          "value": 23
        }
      ],
      "title": "Lifetime Auto-Played Video Views",
      "description": "Lifetime: Number of times your video started automatically playing and people viewed it for 3 seconds or viewed it to the end, whichever came first. (Total Count)",
      "id": "323790578640877/video_insights/total_video_views_autoplayed/lifetime"
    },
    {
      "name": "total_video_views_clicked_to_play",
      "period": "lifetime",
      "values": [
        {
          "value": 12
        }
      ],
    }
    ...
  ]
}

Get Specific Insight Metrics

Send a GET request to the VideoVideoInsights endpoint with the metric parameter and specific metrics you wish to receive.
GET /<API_VERSION>/<VIDEO_ID>/video_insights
  ?metric=total_video_views,total_video_views_unique
  &access_token=<PAGE_ACCESS_TOKEN>"

Sample Request

curl -X GET \
  "https://graph.facebook.com/v20.0/323790578640877/video_insights?metric=total_video_views,total_video_views_unique&access_token=EAABkW..."

Sample Response

{
  "data": [
    {
      "name": "total_video_views",
      "period": "lifetime",
      "values": [
        {
          "value": 2206
        }
      ],
      "title": "Lifetime Total Video Views",
      "description": "Lifetime: Total number of times your video was viewed for 3 seconds or viewed to the end, whichever came first. (Total Count)",
      "id": "323790578640877/video_insights/total_video_views/lifetime"
    },
    {
      "name": "total_video_views_unique",
      "period": "lifetime",
      "values": [
        {
          "value": 6
        }
      ],
      "title": "Lifetime Unique Video Views",
      "description": "Lifetime: Number of unique people who viewed your video for 3 seconds or viewed to the end, whichever came first. (Unique Users)",
      "id": "323790578640877/video_insights/total_video_views_unique/lifetime"
    }
  ]
}

Learn More