Create workflows with API
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.
Category | API Name | Description |
---|---|---|
Views | List video views | To list all the video views. |
Get details of video view | Retrieve information about a specific video view. | |
Errors | List errors | List the total number of playback errors that occurred. |
Metrics | List overall values | To get the value of the metric requested. |
Get timeseries data | Get the timeseries values for the metric requested. | |
List breakdown values | Get the segmented data of metric per dimension. | |
List comparison values | Compare all the aggregated metrics per dimension value. | |
List video views | To list all the video views. | |
Overview | List overall values | To get the value of the metric requested. |
Get timeseries data | Get the timeseries values for the metric requested. | |
List by top Content | To 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 as per your requirements.
Updated 13 days ago