For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • Get started
    • Introduction
    • How Video Data works
  • Web players
    • Monitor the FastPix player
    • Monitor the Shaka player
    • Monitor HLS.js
    • Monitor Video.js
    • Monitor DASH.js
  • Android players
    • Monitor AndroidX Media3
    • Monitor ExoPlayer
    • Monitor Brightcove Player
    • Monitor Bitmovin Player
    • Monitor Kaltura Player
    • Monitor THEOPlayer
  • iOS and cross-platform players
    • Monitor AVPlayer (iOS)
    • Monitor React Native
    • Monitor Better Player (Flutter)
  • Smart TV players
    • Monitor Samsung Tizen
    • Monitor LG webOS
  • Concepts
    • Understand data definitions
    • What Video Data do we capture
    • Audience metrics
    • Quality of experience (QoE) metrics
    • Playback metrics
    • Video startup metrics
    • Stability metrics
    • Render quality metrics
  • Working with video data
    • Explore the dashboard
    • Build workflows with the API
    • Find out why viewers drop off
    • Identify top-performing content
    • Pass custom metadata to metrics
    • Use custom dimensions
    • Troubleshoot playback errors
LogoLogo
StatusSupportDiscussionsLog inSign Up
On this page
  • How to use Video Data APIs
  • We’re dogfooding on our APIs
Working with video data

Build workflows with the API

Learn how to use FastPix Video Data APIs to retrieve, examine, and display viewer insights and playback metrics.
Was this page helpful?
Previous

Find out why viewers drop off

Use FastPix Video Data APIs to identify the causes of viewer churn — from low-engagement segments down to root-cause errors.

Next
Built with

Access detailed Video Data API reference here.

You can use these APIs to pull data into your internal workflows or custom dashboards, data lakes, or automate reports upto a 90-day window. When using our pre-built dashboards data is limited to only 30-days.

Further, if you’re pulling the data and storing into your own database, then it goes even beyond. It entirely depends on how you want to build and customize your product for your users.


PLEASE NOTE

To use any API endpoint – first you would need to generate an access token for authentication.

Follow the guide here.


How to use Video Data APIs

Video Data helps you to answer any business related question by making data-driven decisions. Our APIs are often interlinked and required to be used in certain patterns that gives the output to your queries.


Step 1: Fetch granular data

  • List video views : Retrieve a list of individual video views (raw data).
    Use case: Get all views in a timeframe to analyze session-level details.
  • Get video view details : Drill into a specific view’s metadata (e.g., quality scores, errors).
    Use case: Debug why a specific viewer experienced buffering.

Step 2: Aggregate for trends

  • List by top content : Identify top-performing videos.
    Use case: Find which content drives the most engagement.
  • List overall values : Fetch aggregated metrics (e.g., total views, avg. watch time).
    Use case: Measure your platform-wide performance.

Step 3: Segment & compare data

  • List dimensions : Get all available segmentation options (e.g., country, device).
  • List filter values for a dimension : Filter data or a metric by specific criteria (e.g., “device=mobile”).
  • List breakdown values : Get all data for a metric grouped by segments. (e.g., Watch time by country).

Step 4: Analyze trends over time

  • Get timeseries data : Track metrics over time (e.g., daily views).
    Use case: Identify peak engagement hours.

Step 5: Diagnose playback issues

  • List errors : List common errors (e.g., buffering, playback failures).
  • List comparison values : Compare error rates across segments (e.g., “Error A vs. Error B”).



We’re dogfooding on our APIs

Here’s a list of APIs that we used to build our own Video Data dashboards. This would likely give you an overall idea about how the APIs work and their use cases.


CategoryAPI NameDescription
ViewsList video viewsTo list all the video views.
Get details of video viewRetrieve information about a specific video view.
ErrorsList errorsList the total number of playback errors that occurred.
MetricsList overall valuesTo get the value of the metric requested.
Get timeseries dataGet the timeseries values for the metric requested.
List breakdown valuesGet the segmented data of metric per dimension.
List comparison valuesCompare all the aggregated metrics per dimension value.
List video viewsTo list all the video views.
OverviewList overall valuesTo get the value of the metric requested.
Get timeseries dataGet the timeseries values for the metric requested.
List by top ContentTo get the list of top-performing videos.

These are some (not all) of the major API endpoints that pulls the data on the specific dashboard it is listed for. For instance, if you’re building a Views dashboard you are likely to use a mix of few other APIs to fetch data and customize as per your requirements.