List comparison values | FastPix Developer Documentation

curl https://api.fastpix.com/v1/data/metrics/comparison \
     -u "<username>:<password>"

{
  "success": true,
  "data": [
    {
      "value": 6,
      "type": "number",
      "name": "Views",
      "metric": "views",
      "measurement": "count",
      "items": [
        {
          "value": 6,
          "type": "number",
          "name": "Unique Viewers",
          "metric": "uniqueViewers",
          "measurement": "count",
          "items": null
        },
        {
          "value": 503934,
          "type": "milliseconds",
          "name": "Playing Time",
          "metric": "playingTime",
          "measurement": "sum",
          "items": null
        }
      ]
    }
  ],
  "timespan": [
    1610025789,
    1610025947
  ]
}

This endpoint lets you to compare multiple metrics across specified dimensions. You can specify the metrics you want to compare in the query parameters, and the response includes the relevant metrics for the specified dimensions. #### Key fields in response * **value:** The specific metric value calculated based on the applied filters. * **type:** The data unit or format type (for example, "number", "milliseconds", "percentage"). * **name:** The display name of the metric (for example, "Views", "Overall Score"). * **metric:** The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality. * **items:** Nested breakdown of related metrics for more detailed analysis. * **measurement:** Defines the aggregation type (for example, "avg", "sum", "median", "95th"). #### How it works 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison. 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters. 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions. Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>

curl https://api.fastpix.com/v1/data/metrics/comparison \
     -u "<username>:<password>"

{
  "success": true,
  "data": [
    {
      "value": 6,
      "type": "number",
      "name": "Views",
      "metric": "views",
      "measurement": "count",
      "items": [
        {
          "value": 6,
          "type": "number",
          "name": "Unique Viewers",
          "metric": "uniqueViewers",
          "measurement": "count",
          "items": null
        },
        {
          "value": 503934,
          "type": "milliseconds",
          "name": "Playing Time",
          "metric": "playingTime",
          "measurement": "sum",
          "items": null
        }
      ]
    }
  ],
  "timespan": [
    1610025789,
    1610025947
  ]
}

Key fields in response

value: The specific metric value calculated based on the applied filters.
type: The data unit or format type (for example, “number”, “milliseconds”, “percentage”).
name: The display name of the metric (for example, “Views”, “Overall Score”).
metric: The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
items: Nested breakdown of related metrics for more detailed analysis.
measurement: Defines the aggregation type (for example, “avg”, “sum”, “median”, “95th”).

How it works

Before making a request to this endpoint, call the list dimensions endpoint to obtain all available dimensions that can be used for comparison.
Send a GET request to this endpoint with the desired metrics specified in the query parameters.
You Receive a response containing the comparison values for the specified metrics across the selected dimensions.

Related guide: Compare metrics in dashboard

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.

Username: Access Token ID
Password: Secret Key

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

Query parameters

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 ]

dimensionenumOptional

The dimension id in which the views are watched.

valuestringOptional

The value for the selected dimension. For example: If dimension is browser_name, the value could be Chrome , Firefox etc . If dimension is os_name, the value could be macOS , Windows etc .

Response

Get filter/ dimension value details by dimension name.

successboolean

Shows the request status. Returns true for success and false for failure.

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.

$	curl https://api.fastpix.com/v1/data/metrics/comparison \
>	-u "<username>:<password>"

1	{
2	"success": true,
3	"data": [
4	{
5	"value": 6,
6	"type": "number",
7	"name": "Views",
8	"metric": "views",
9	"measurement": "count",
10	"items": [
11	{
12	"value": 6,
13	"type": "number",
14	"name": "Unique Viewers",
15	"metric": "uniqueViewers",
16	"measurement": "count",
17	"items": null
18	},
19	{
20	"value": 503934,
21	"type": "milliseconds",
22	"name": "Playing Time",
23	"metric": "playingTime",
24	"measurement": "sum",
25	"items": null
26	}
27	]
28	}
29	],
30	"timespan": [
31	1610025789,
32	1610025947
33	]
34	}