> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# List comparison values

GET https://api.fastpix.com/v1/data/metrics/comparison

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 list dimensions 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: Compare metrics in dashboard

Reference: https://fastpix.com/docs/video-data-api/metrics/list-comparison-values

## Authentication

- `Authorization` header (basic auth, required) — 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

## Request

### Query parameters

- `timespan[]` (enum, optional) — 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`
  - Allowed values: `60:minutes`, `6:hours`, `24:hours`, `3:days`, `7:days`, `30:days`
- `filterby[]` (string, optional) — 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 ]
- `dimension` (enum, optional) — The dimension id in which the views are watched.
  - Allowed values: `browser_name`, `browser_version`, `os_name`, `os_version`, `device_name`, `device_model`, `device_type`, `device_manufacturer`, `player_remote_played`, `player_name`, `player_version`, `player_software_name`, `player_software_version`, `player_resolution`, `fp_sdk`, `fp_sdk_version`, `player_autoplay_on`, `player_preload_on`, `video_title`, `video_id`, `video_series`, `fp_playback_id`, `fp_live_stream_id`, `media_id`, `video_source_stream_type`, `video_source_type`, `video_encoding_variant`, `experiment_name`, `sub_property_id`, `drm_type`, `asn_name`, `cdn`, `video_source_hostname`, `connection_type`, `view_session_id`, `continent`, `country`, `region`, `viewer_id`, `error_code`, `exit_before_video_start`, `view_has_ad`, `video_startup_failed`, `page_context`, `video_content_type`, `playback_failed`, `custom_1`, `custom_2`, `custom_3`, `custom_4`, `custom_5`, `custom_6`, `custom_7`, `custom_8`, `custom_9`, `custom_10`
- `value` (string, optional) — 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

### 200

Get filter/ dimension value details by dimension name.

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (list of MetricsComparisonDetails, optional) — Displays the result of the request.
- `timespan` (list of integer, optional) — The timespan from and to details displayed in the form of unix epoch timestamps.

## Types

### MetricsComparisonDetails

Compare multiple metrics across specified dimensions.

- `value` (double, optional) — The specific metric value calculated based on the applied filters.
- `type` (string, optional) — value can be score that ranges from 0 to 100
- `name` (string, optional) — value can be score that ranges from 0 to 100
- `metric` (string, optional) — 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.
- `measurement` (string, optional, nullable) — value can be avg, sum, count or 95th
- `items` (list of MetricsComparisonDetails, optional, nullable) — Nested comparison items

## Examples

**Response**

```json
{
  "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
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/data/metrics/comparison"

response = requests.get(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/data/metrics/comparison';
const credentials = btoa("<username>:<password>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fastpix.com/v1/data/metrics/comparison"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fastpix.com/v1/data/metrics/comparison")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fastpix.com/v1/data/metrics/comparison")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fastpix.com/v1/data/metrics/comparison', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/data/metrics/comparison");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/data/metrics/comparison")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```