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

# Query impact metrics time series data

GET https://app.unleash-instance.example.com/api/admin/impact-metrics

**Enterprise feature**

Queries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.

Reference: https://docs.getunleash.io/api/query-impact-metrics-time-series

## Authentication

- `Authorization` header (required) — API key needed to access this API
- `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format

## Request

### Query parameters

- `metricName` (string, required) — The Prometheus metric name to query.
- `range` (enum, required) — The time range for the query.
  - Allowed values: `hour`, `day`, `week`, `month`, `threeMonths`, `sixMonths`
- `aggregationMode` (enum, required) — The aggregation mode for the query.
  - Allowed values: `rps`, `count`, `avg`, `sum`, `p50`, `p95`, `p99`
- `labels` (string, optional) — A JSON-encoded object mapping label names to arrays of label values to filter by.
- `mode` (enum, optional) — Query mode. `edit` (default) also returns the available labels for the metric (used by filter UIs). `display` skips label discovery and returns time-series data only (cheaper; use for dashboard rendering).
  - Allowed values: `display`, `edit`
- `source` (enum, required, default: internal) — Whether the metric comes from the internal Unleash impact metrics or an external source.
  - Allowed values: `internal`, `external`

## Response

### 200

impactMetricsDataSchema

- `start` (string, required) — The start of the queried time range as a Unix epoch timestamp in seconds.
- `end` (string, required) — The end of the queried time range as a Unix epoch timestamp in seconds.
- `step` (string, required) — The step interval between data points.
- `series` (list of object, required) — Array of time series results.
  - `metric` (map from string to string, required) — Label key-value pairs identifying this series.
  - `data` (list of list of double or string, required) — Array of [timestamp, value] data points. Timestamps are Unix epoch seconds; values are strings.
- `labels` (map from string to list of string, required) — Available label values for the queried metric, keyed by label name.
- `debug` (object, optional) — Internal debug information. This field is not part of the public API and may be removed without notice.
  - `query` (string, optional) — The PromQL query that was executed.
  - `metricType` (string, optional) — The resolved metric type.
  - `isTruncated` (boolean, optional) — Whether the series data was truncated due to limits.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "start": "1712745600",
  "end": "1712832000",
  "step": "15m",
  "series": [
    {
      "metric": {
        "endpoint": "/api/admin",
        "method": "GET",
        "status": "200"
      },
      "data": [
        [
          1712745600,
          "120"
        ],
        [
          1712746500,
          "135"
        ],
        [
          1712747400,
          "150"
        ]
      ]
    }
  ],
  "labels": {
    "endpoint": [
      "/api/admin",
      "/api/user",
      "/api/metrics"
    ],
    "method": [
      "GET",
      "POST",
      "PUT"
    ],
    "status": [
      "200",
      "404",
      "500"
    ]
  },
  "debug": {
    "query": "sum(rate(http_requests_total{endpoint=\"/api/admin\"}[5m])) by (method, status)",
    "metricType": "counter",
    "isTruncated": false
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/impact-metrics"

querystring = {"aggregationMode":"rps","labels":"{\"endpoint\":[\"/api/admin\"]}","metricName":"http_requests_total","mode":"display","range":"day","source":"external"}

payload = {}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external';
const options = {
  method: 'GET',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	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://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/impact-metrics?aggregationMode=rps&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&metricName=http_requests_total&mode=display&range=day&source=external")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```