> ## Documentation Index
> Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Routing Metrics: Response Format

> Response structure for Gateway routing metrics API queries

## Response format

Every successful response has the same outer shape:

```json theme={"dark"}
{
  "data": {
    "dataPoints": [
      {
        "startTimestamp": "2026-04-29T12:00:00.000Z",
        "endTimestamp": "2026-04-29T13:00:00.000Z",
        "total": 1234,
        "<aggregationKey>": 0,
        "<groupByKey>": "value-or-null"
      }
    ]
  }
}
```

* **`total`**: implicit `COUNT(*)` for the row. Always present.
* **`<aggregationKey>`**: one key per requested aggregation. The key is `<type><Column>` in camelCase (e.g. `sumLoadbalanceTargetAttemptCount`, `avgLoadbalanceTargetAttemptCount`).
* **`<groupByKey>`**: one key per `groupBy` entry. The key is the lowerCamelCase form of the underlying column. Two special mappings:
  * `userEmail` and `virtualaccount` both map to `createdBySubjectSlug` in the response.
  * `team` maps to `team` (the value is a single unnested scalar, not an array).
    All other `groupBy` keys preserve their lowerCamelCase name.
* **`startTimestamp`**: present only for timeseries responses. Bucket start as an ISO 8601 timestamp string (e.g. `"2026-04-29T12:00:00.000Z"`). Distribution responses omit it.
* **`endTimestamp`**: present only for timeseries responses. Bucket end as an ISO 8601 timestamp string, equal to the next bucket's `startTimestamp` (e.g. `"2026-04-29T13:00:00.000Z"`). Distribution responses omit it.

### Distribution response example

```json theme={"dark"}
{
  "data": {
    "dataPoints": [
      {
        "loadbalanceRuleId": "lb-rule-prod",
        "requestedModel": "gpt-4",
        "targetModel": "gpt-4o",
        "status": "success",
        "total": 1240,
        "sumLoadbalanceTargetAttemptCount": 1260,
        "avgLoadbalanceTargetAttemptCount": 1.016
      },
      {
        "loadbalanceRuleId": "lb-rule-prod",
        "requestedModel": "gpt-4",
        "targetModel": "gpt-4o-mini",
        "status": "success",
        "total": 360,
        "sumLoadbalanceTargetAttemptCount": 412,
        "avgLoadbalanceTargetAttemptCount": 1.144
      }
    ]
  }
}
```

### Timeseries response example

```json theme={"dark"}
{
  "data": {
    "dataPoints": [
      {
        "startTimestamp": "2026-04-21T00:00:00.000Z",
        "endTimestamp": "2026-04-21T01:00:00.000Z",
        "requestedModel": "gpt-4",
        "targetModel": "gpt-4o",
        "total": 52,
        "sumLoadbalanceTargetAttemptCount": 54
      },
      {
        "startTimestamp": "2026-04-21T01:00:00.000Z",
        "endTimestamp": "2026-04-21T02:00:00.000Z",
        "requestedModel": "gpt-4",
        "targetModel": "gpt-4o",
        "total": 61,
        "sumLoadbalanceTargetAttemptCount": 63
      }
    ]
  }
}
```

<Info>
  If `groupBy` is empty or omitted, the response collapses to a single row (or one row per timeseries bucket) summarising every rule application inside the window.
</Info>

## Error responses

A malformed query returns `400 Bad Request`:

```json theme={"dark"}
{
  "statusCode": 400,
  "message": "Invalid query",
  "details": ["..."]
}
```

Common causes:

* Unsupported field name for `configMetrics`. The error message is typically `Unsupported gateway config filter name: <field>`. Notably, `httpStatusCode`, `errorType`, and `latencyMs` are **not** filterable on this datasource; use `status` in `groupBy` for outcome breakdowns.
* Operator not allowed on this field. For example, `STRING_CONTAINS` on `loadbalanceRuleId` (it supports only `IN`/`NOT_IN`).
* Missing required `value` (or wrong shape, e.g. scalar where array is expected for `IN`).
* Invalid `interval` format (compound expressions, unrecognised unit, non-positive integer).
* Missing required `interval` for a timeseries query.

Other status codes:

* `401 Unauthorized`: missing or invalid bearer token.
* `403 Forbidden`: caller does not have permission for the requested scope.
* `500 Internal Server Error`: unexpected server error while executing the query.