API Access to Routing Metrics

The Gateway Routing Metrics Query API provides a flexible way to query routing, ratelimit, and budget rule applications: which rule matched a request, where the request was routed, and what happened. You can retrieve either distribution (aggregated) or timeseries results with powerful filtering and grouping.

This page covers datasource: "configMetrics" (the internal literal). The UI sometimes refers to this as Gateway Routing metrics. For other datasources, see the sibling pages for Model, MCP, Guardrail, Cache, and Agent metrics.

Access control

Tenant admins: Can query metrics for the entire organization (tenant-wide).
Users: Can query their own data and their teams’ data.
Virtual accounts: Can query their own data and their teams’ data; with tenant-admin permissions, they can access tenant-wide data.

The server applies RBAC automatically; callers don’t pass any RBAC fields.

Section	Description
Overview	Authentication, quick start, and API reference
Filtering	Filter operators, fields, and combinations
Distribution examples	Aggregated (distribution) query examples
Timeseries examples	Time-bucketed (timeseries) query examples
Response format	Response JSON structure and error responses

Authentication

You need to authenticate with your TrueFoundry API key. You can use either a Personal Access Token (PAT) or Virtual Account Token (VAT).

Get your API key

To generate an API key:

Personal Access Token (PAT): Go to Access → Personal Access Tokens in your TrueFoundry dashboard
Virtual Account Token (VAT): Go to Access → Virtual Account Tokens (requires admin permissions)

For detailed authentication setup, see our Authentication guide.

Quick Start

Distribution query

Loadbalance attempt counts grouped by rule, requested model, target model, and outcome:

import requests

response = requests.post(
    "https://{your_control_plane_url}/api/svc/v1/llm-gateway/metrics/query",
    headers={
        "Authorization": "Bearer <your_api_key>",
        "Content-Type": "application/json"
    },
    json={
        "startTs": "2026-04-21T00:00:00.000Z",
        "endTs": "2026-04-22T00:00:00.000Z",
        "datasource": "configMetrics",
        "type": "distribution",
        "aggregations": [
            {"type": "sum", "column": "loadbalanceTargetAttemptCount"},
            {"type": "avg", "column": "loadbalanceTargetAttemptCount"}
        ],
        "groupBy": ["loadbalanceRuleId", "requestedModel", "targetModel", "status"]
    }
)

print(response.json())

Timeseries query

Hourly routing volume by requested-to-target pair:

import requests

response = requests.post(
    "https://{your_control_plane_url}/api/svc/v1/llm-gateway/metrics/query",
    headers={
        "Authorization": "Bearer <your_api_key>",
        "Content-Type": "application/json"
    },
    json={
        "startTs": "2026-04-21T00:00:00.000Z",
        "endTs": "2026-04-22T00:00:00.000Z",
        "datasource": "configMetrics",
        "type": "timeseries",
        "interval": "1 hour",
        "aggregations": [
            {"type": "sum", "column": "loadbalanceTargetAttemptCount"}
        ],
        "groupBy": ["requestedModel", "targetModel"]
    }
)

print(response.json())

API reference

Endpoint

POST https://{your_control_plane_url}/api/svc/v1/llm-gateway/metrics/query

Post JSON to this endpoint with Authorization: Bearer <your_api_key> and Content-Type: application/json.

Request parameters

startTs

string

required

ISO 8601 timestamp marking the inclusive lower bound of the query window.

endTs

string

required

ISO 8601 timestamp marking the exclusive upper bound of the query window.

datasource

string

required

The data source to query. Use "configMetrics" for Gateway routing metrics.

type

string

required

The type of query to execute:

"distribution": returns aggregated rows (one row per groupBy combination).
"timeseries": returns time-bucketed rows. Requires interval.

aggregations

array

Array of { type, column } objects describing the aggregations to compute. When omitted, only the implicit total = COUNT(*) is returned.Supported aggregation types

Type	Description
`sum`	Sum of values
`count`	Non-null count of the column
`countDistinct`	Distinct count
`min`	Minimum value
`max`	Maximum value
`avg`	Average
`p5`, `p10`, `p25`, `p50`, `p75`, `p90`, `p95`, `p99`, `p999`	Percentiles (approximate)
`rateSum`, `rateAvg`, `rateMin`, `rateMax`	Rates normalised by the interval in seconds (timeseries only)
`ratePerMinute`	Value divided by the interval in minutes (timeseries only)

Supported aggregation columns

Column	Notes
`loadbalanceTargetAttemptCount`	Number of loadbalance targets attempted. Supports `sum`, `avg`, `min`, `max`, percentiles

groupBy

array

Array of field names to group results by. Custom metadata keys are supported with a metadata. prefix.Available group-by fields

Field	Notes
`loadbalanceRuleId`	The matched loadbalance rule
`ratelimitRuleId`	The matched ratelimit rule
`budgetRuleId`	The matched budget rule
`requestedModel`	The model the caller asked for
`targetModel`	The model the request was actually routed to
`loadbalanceTargetAttemptCount`	How many loadbalance targets were attempted
`configType`	Distinguishes config flavour (e.g. `loadbalance`, `ratelimit`, `budget`)
`status`	Outcome (e.g. `success`, `fail`)
`userEmail`	Group by user (response key: `createdBySubjectSlug`)
`virtualaccount`	Group by virtual account (response key: `createdBySubjectSlug`)
`team`	Unnests the `Teams` array
`createdBySubjectType`	Distinguishes `user` vs `virtualaccount`
`metadata.<key>`	Group by a custom metadata key

When groupBy contains userEmail (without virtualaccount), the server auto-injects WHERE CreatedBySubjectType = 'user'. virtualaccount alone auto-injects 'virtualaccount'. When both appear, scope it yourself with createdBySubjectType if needed.

filters

array

Array of filter objects, AND-combined. See Filtering for the full operator reference and the per-field allow-list.

interval

string

Required for timeseries queries. Bucket size as <positive integer> <unit>, where <unit> is one of second, minute, hour, day, week, month, year (with or without a trailing s). Examples: "30 second", "5 minute", "1 hour", "1 day". Compound expressions like "1 hour 30 minute" are rejected.

intervalInSeconds

number

deprecated

Deprecated alias for interval. Accepts a positive integer number of seconds. Prefer interval in new code. If both are provided, interval wins.

API Access to Routing Metrics

Access control

Contents

Authentication

Quick Start

Distribution query

Timeseries query

API reference

Endpoint

Request parameters

Query Examples

​Access control

​Contents

​Authentication

​Quick Start

​Distribution query

​Timeseries query

​API reference

​Endpoint

​Request parameters

Query Examples

Access control

Contents

Authentication

Quick Start

Distribution query

Timeseries query

API reference

Endpoint

Request parameters