> 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 overall values

GET https://api.fastpix.com/v1/data/metrics/{metricId}/overall

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

Reference: https://fastpix.com/docs/video-data-api/metrics/list-overall-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

### Path parameters

- `metricId` (enum, required) — Pass metric Id
  - Allowed values: `views`, `unique_viewers`, `playing_time`, `quality_of_experience_score`, `playback_score`, `playback_failure_percentage`, `exit_before_video_start`, `video_startup_failure_percentage`, `startup_score`, `video_startup_time`, `player_startup_time`, `page_load_time`, `total_startup_time`, `live_stream_latency`, `average_bitrate`, `buffer_count`, `render_quality_score`, `avg_upscaling`, `avg_downscaling`, `max_upscaling`, `max_downscaling`, `jump_latency`, `stability_score`, `buffer_ratio`, `buffer_frequency`, `buffer_fill`

### Query parameters

- `measurement` (string, optional, default: avg) — The measurement for the given metrics. Possible Values : [95th, median, avg, count or sum]
- `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 ]

## 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.
- `metadata` (MetricsOverallmetadataDetails, optional) — metadata that has to be paased for metric calculations.
- `data` (MetricsOverallDataDetails, optional) — Retrieves overall values for a specified metric
- `timespan` (list of integer, optional) — The timespan from and to details displayed in the form of unix epoch timestamps.

## Types

### MetricsOverallmetadataDetails

metadata that has to be paased for metric calculations.

- `aggregation` (string, optional) — defines the field or dimension on which the aggregation is to be applied.

### MetricsOverallDataDetails

Retrieves overall values for a specified metric

- `value` (double, optional, nullable) — metric value calculated based on the applied filters.
- `totalWatchTime` (integer, optional, nullable) — Total time watched across all views, represented in milliseconds.
- `uniqueViews` (integer, optional, nullable) — The count of unique viewers who interacted with the content.
- `totalViews` (integer, optional, nullable) — The total number of views recorded.
- `totalPlayTime` (integer, optional, nullable) — Total time spent playing the video, represented in milliseconds.
- `globalValue` (double, optional, nullable) — A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan.

## Examples

**Response**

```json
{
  "success": true,
  "metadata": {
    "aggregation": "view_end"
  },
  "data": {
    "value": 0.740365072855583,
    "totalWatchTime": 59534302,
    "uniqueViews": 44,
    "totalViews": 195,
    "totalPlayTime": 24729470,
    "globalValue": 0.740365072855583
  },
  "timespan": [
    1610025789,
    1610025947
  ]
}
```

**SDK Code**

```python
import requests

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

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

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/data/metrics/views/overall';
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/views/overall"

	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/views/overall")

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/views/overall")
  .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/views/overall', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

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

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

var client = new RestClient("https://api.fastpix.com/v1/data/metrics/views/overall");
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/views/overall")! 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()
```