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

Get timeseries data

GET
https://api.fastpix.com/v1/data/metrics/:metricId/timeseries
GET
/v1/data/metrics/:metricId/timeseries
$curl https://api.fastpix.com/v1/data/metrics/views/timeseries \
>     -u "<username>:<password>"
200Retrieved
1{
2  "success": true,
3  "metadata": {
4    "granularity": "day",
5    "aggregation": "view_end"
6  },
7  "data": [
8    {
9      "intervalTime": "2023-12-04T14:00:00Z",
10      "metricValue": 0.793110142151515,
11      "numberOfViews": 143244
12    }
13  ],
14  "timespan": [
15    1610025789,
16    1610025947
17  ]
18}
This endpoint retrieves timeseries data for a specified metric, providing insights into how the metric values change over time. The response includes an array of data points, each representing the metrics value at specific intervals. #### Key fields in response * **intervalTime:** The timestamp for the data point indicating when the metric value was recorded. * **metricValue:** The value of the specified metric at the given interval, reflecting the performance or engagement level during that time. * **numberOfViews:** The total number of views recorded during that interval, providing context for the metric value.
Was this page helpful?
Previous

List comparison values

Next
Built with

This endpoint retrieves timeseries data for a specified metric, providing insights into how the metric values change over time. The response includes an array of data points, each representing the metrics value at specific intervals.

Key fields in response

  • intervalTime: The timestamp for the data point indicating when the metric value was recorded.
  • metricValue: The value of the specified metric at the given interval, reflecting the performance or engagement level during that time.
  • numberOfViews: The total number of views recorded during that interval, providing context for the metric value.

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

groupByenumOptionalDefaults to minute
Pass this value to group the metrics list by.
Allowed values:
sortOrderenumOptionalDefaults to asc
The order direction to sort the metrics list by.
Allowed values:
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
Retrieves breakdown values for a specified metric and timespan
datalist of objects
Displays the result of the request.
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

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