> 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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: admin-api
  version: 1.0.0
paths:
  /api/admin/impact-metrics:
    get:
      operationId: query-impact-metrics-time-series
      summary: Query impact metrics time series data
      description: >-
        **Enterprise feature**


        Queries an impact metric source for time series data based on the
        provided metric name, time range, and aggregation mode.
      tags:
        - subpackage_metrics
      parameters:
        - name: metricName
          in: query
          description: The Prometheus metric name to query.
          required: true
          schema:
            type: string
        - name: range
          in: query
          description: The time range for the query.
          required: true
          schema:
            $ref: '#/components/schemas/ApiAdminImpactMetricsGetParametersRange'
        - name: aggregationMode
          in: query
          description: The aggregation mode for the query.
          required: true
          schema:
            $ref: >-
              #/components/schemas/ApiAdminImpactMetricsGetParametersAggregationMode
        - name: labels
          in: query
          description: >-
            A JSON-encoded object mapping label names to arrays of label values
            to filter by.
          required: false
          schema:
            type: string
        - name: mode
          in: query
          description: >-
            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).
          required: false
          schema:
            $ref: '#/components/schemas/ApiAdminImpactMetricsGetParametersMode'
        - name: source
          in: query
          description: >-
            Whether the metric comes from the internal Unleash impact metrics or
            an external source.
          required: true
          schema:
            $ref: '#/components/schemas/ApiAdminImpactMetricsGetParametersSource'
        - name: Authorization
          in: header
          description: API key needed to access this API
          required: true
          schema:
            type: string
      responses:
        '200':
          description: impactMetricsDataSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/impactMetricsDataSchema'
        '401':
          description: >-
            Authorization information is missing or invalid. Provide a valid API
            token as the `authorization` header, e.g.
            `authorization:*.*.my-admin-token`.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/QueryImpactMetricsTimeSeriesRequestUnauthorizedError
        '403':
          description: >-
            The provided user credentials are valid, but the user does not have
            the necessary permissions to perform this operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/QueryImpactMetricsTimeSeriesRequestForbiddenError
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/QueryImpactMetricsTimeSeriesRequestNotFoundError
servers:
  - url: https://app.unleash-instance.example.com
    description: Your Unleash instance (replace with your actual URL)
components:
  schemas:
    ApiAdminImpactMetricsGetParametersRange:
      type: string
      enum:
        - hour
        - day
        - week
        - month
        - threeMonths
        - sixMonths
      title: ApiAdminImpactMetricsGetParametersRange
    ApiAdminImpactMetricsGetParametersAggregationMode:
      type: string
      enum:
        - rps
        - count
        - avg
        - sum
        - p50
        - p95
        - p99
      title: ApiAdminImpactMetricsGetParametersAggregationMode
    ApiAdminImpactMetricsGetParametersMode:
      type: string
      enum:
        - display
        - edit
      title: ApiAdminImpactMetricsGetParametersMode
    ApiAdminImpactMetricsGetParametersSource:
      type: string
      enum:
        - internal
        - external
      default: internal
      title: ApiAdminImpactMetricsGetParametersSource
    ImpactMetricsDataSchemaSeriesItemsDataItemsItems:
      oneOf:
        - type: number
          format: double
        - type: string
      title: ImpactMetricsDataSchemaSeriesItemsDataItemsItems
    ImpactMetricsDataSchemaSeriesItems:
      type: object
      properties:
        metric:
          type: object
          additionalProperties:
            type: string
          description: Label key-value pairs identifying this series.
        data:
          type: array
          items:
            type: array
            items:
              $ref: >-
                #/components/schemas/ImpactMetricsDataSchemaSeriesItemsDataItemsItems
          description: >-
            Array of [timestamp, value] data points. Timestamps are Unix epoch
            seconds; values are strings.
      required:
        - metric
        - data
      title: ImpactMetricsDataSchemaSeriesItems
    ImpactMetricsDataSchemaDebug:
      type: object
      properties:
        query:
          type: string
          description: The PromQL query that was executed.
        metricType:
          type: string
          description: The resolved metric type.
        isTruncated:
          type: boolean
          description: Whether the series data was truncated due to limits.
      description: >-
        Internal debug information. This field is not part of the public API and
        may be removed without notice.
      title: ImpactMetricsDataSchemaDebug
    impactMetricsDataSchema:
      type: object
      properties:
        start:
          type: string
          description: >-
            The start of the queried time range as a Unix epoch timestamp in
            seconds.
        end:
          type: string
          description: >-
            The end of the queried time range as a Unix epoch timestamp in
            seconds.
        step:
          type: string
          description: The step interval between data points.
        series:
          type: array
          items:
            $ref: '#/components/schemas/ImpactMetricsDataSchemaSeriesItems'
          description: Array of time series results.
        labels:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Available label values for the queried metric, keyed by label name.
        debug:
          $ref: '#/components/schemas/ImpactMetricsDataSchemaDebug'
          description: >-
            Internal debug information. This field is not part of the public API
            and may be removed without notice.
      required:
        - start
        - end
        - step
        - series
        - labels
      description: Response containing time series data from a metrics source.
      title: impactMetricsDataSchema
    QueryImpactMetricsTimeSeriesRequestUnauthorizedError:
      type: object
      properties:
        id:
          type: string
          description: The ID of the error instance
        name:
          type: string
          description: The name of the error kind
        message:
          type: string
          description: A description of what went wrong.
      title: QueryImpactMetricsTimeSeriesRequestUnauthorizedError
    QueryImpactMetricsTimeSeriesRequestForbiddenError:
      type: object
      properties:
        id:
          type: string
          description: The ID of the error instance
        name:
          type: string
          description: The name of the error kind
        message:
          type: string
          description: A description of what went wrong.
      title: QueryImpactMetricsTimeSeriesRequestForbiddenError
    QueryImpactMetricsTimeSeriesRequestNotFoundError:
      type: object
      properties:
        id:
          type: string
          description: The ID of the error instance
        name:
          type: string
          description: The name of the error kind
        message:
          type: string
          description: A description of what went wrong.
      title: QueryImpactMetricsTimeSeriesRequestNotFoundError
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: API key needed to access this API
    bearerToken:
      type: http
      scheme: bearer
      description: API key needed to access this API, in Bearer token format

```

## 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\"}[1m])) by (method, status)",
    "metricType": "counter",
    "isTruncated": false
  }
}
```

**SDK Code**

```python
import requests

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

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

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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display';
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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display"

	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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display")

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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display")
  .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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display', [
  '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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display");
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?metricName=http_requests_total&range=day&aggregationMode=rps&source=external&labels=%7B%22endpoint%22%3A%5B%22%2Fapi%2Fadmin%22%5D%7D&mode=display")! 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()
```