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
  • ACTIVATE ACCOUNT
    • Create account
  • PRODUCT OS API
    • Overview
  • ERROR CODES
    • Error codes
  • VIDEO ON DEMAND API
    • Overview
  • LIVE STREAM API
    • Overview
  • VIDEO DATA API
    • Overview
      • GETList breakdown values
      • GETList overall values
      • GETGet timeseries data
      • GETList comparison values
LogoLogo
StatusSupportDiscussionsLog inSign Up
VIDEO DATA APIMetrics

List overall values

GET
https://api.fastpix.com/v1/data/metrics/:metricId/overall
GET
/v1/data/metrics/:metricId/overall
$curl https://api.fastpix.com/v1/data/metrics/views/overall \
> -u "<username>:<password>"
200Retrieved
1{
2 "success": true,
3 "metadata": {
4 "aggregation": "view_end"
5 },
6 "data": {
7 "value": 0.740365072855583,
8 "totalWatchTime": 59534302,
9 "uniqueViews": 44,
10 "totalViews": 195,
11 "totalPlayTime": 24729470,
12 "globalValue": 0.740365072855583
13 },
14 "timespan": [
15 1610025789,
16 1610025947
17 ]
18}
Retrieves overall values for a specified metric, providing summary statistics that help you understand the performance of your content. The response includes key metrics such as `totalWatchTime`, `uniqueViews`, `totalPlayTime` and `totalViews`. #### How it works 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query. 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters. 3. You receive a response containing the overall values for the specified metric, which may vary based on the applied filters. #### Key fields in response * **value:** The specific metric value calculated based on the applied filters. * **totalWatchTime:** Total time watched across all views, represented in milliseconds. * **uniqueViews:** The count of unique viewers who interacted with the content. * **totalViews:** The total number of views recorded. * **totalPlayTime:** Total time spent playing the video, represented in milliseconds. * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters. Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
Was this page helpful?
Previous

Get timeseries data

Next
Built with

Retrieves overall values for a specified metric, providing summary statistics that help you understand the performance of your content. The response includes key metrics such as totalWatchTime, uniqueViews, totalPlayTime and totalViews.

How it works

  1. Before using this endpoint, you can call the list dimensions endpoint to retrieve all available dimensions that can be used in your query.

  2. Send a GET request to this endpoint with the required metricId and other query parameters.

  3. You receive a response containing the overall values for the specified metric, which may vary based on the applied filters.

Key fields in response

  • value: The specific metric value calculated based on the applied filters.
  • totalWatchTime: Total time watched across all views, represented in milliseconds.
  • uniqueViews: The count of unique viewers who interacted with the content.
  • totalViews: The total number of views recorded.
  • totalPlayTime: Total time spent playing the video, represented in milliseconds.
  • globalValue: A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.

Related guide: Understand data definitions

Authentication

AuthorizationBasic
FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

metricIdenumRequired
Pass metric Id

Query parameters

measurementstringOptionalDefaults to avg

The measurement for the given metrics. Possible Values : [95th, median, avg, count or sum]

timespan[]enumOptional

This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.

Accepted formats are:

array of epoch timestamps for example timespan[]=1498867200&timespan[]=1498953600

duration string for example
timespan[]=24:hours or timespan[]=7:days

filterby[]stringOptional

Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass ”!” before the filter value. The list of filters can be obtained from list of dimensions endpoint. Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]

Response

Get filter/ dimension value details by dimension name.

successboolean
Shows the request status. Returns true for success and false for failure.
metadataobject
metadata that has to be paased for metric calculations.
dataobject
Retrieves overall values for a specified metric
timespanlist of integers
The timespan from and to details displayed in the form of unix epoch timestamps.

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here