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

# Query telemetry

> Canonical neutral query envelope for traces, metrics, and logs. Select a source, compute list, and time range; optionally group, filter, bucket, sort, limit, and include totals. ReportingService.QueryReport and TraceQueryService.AggregateTraces remain supported compatibility contracts.



## OpenAPI

````yaml post /v3/telemetry/query
openapi: 3.1.0
info:
  title: Toqan Router API
  version: '2.0'
  description: Toqan Router API documentation
servers:
  - url: https://router.toqan.ai/eu
    description: Frankfurt (Europe)
  - url: https://router.toqan.ai/br
    description: São Paulo (Brazil)
security:
  - ApiKey: []
tags:
  - description: >-
      API keys authenticate programmatic access to the workspace. They expose
      opaque tokens, per-domain access grants, and budget and rate-limit
      constraints.
    name: API keys
  - name: Logs
    description: >-
      OpenTelemetry log query API. Search, filter, aggregate, and facet log
      records ingested via OTLP.
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
  - name: Telemetry
    description: >-
      Unified query envelope for traces, metrics, and logs. One request shape,
      one filter dialect, and one response shape per source, validated by a
      per-source registry.
  - name: Traces
    description: >-
      Query and inspect ingested trace data: search trace summaries, aggregate
      metrics, and read individual traces and their spans.
  - name: Views
    description: Saved filters and columns for workspace observability pages.
  - description: List models available through the AI Router.
    name: Models
  - name: Alerts
    description: >-
      Alerts evaluate a telemetry metric on a fixed interval and fire
      notifications through notifiers when the value breaches a threshold. Each
      breach opens a trigger that tracks the incident until the value recovers.
  - name: Annotation Queues
    description: Annotation queues collect spans for human review.
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, API key, provider, and model. Every
      applicable budget is enforced, and the most restrictive limit applies per
      dimension.
  - name: Files
    description: File upload and retrieval operations.
  - name: Guardrail Rules
    description: >-
      Guardrail Rules conditionally enforce evaluators and plugins for AI
      Gateway traffic. Rules may be scoped to a project or the whole workspace.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Management keys
    description: >-
      Management keys are workspace-scoped credentials that authenticate
      programmatic access to workspace administration surfaces (API keys,
      budgets). Unlike project-scoped API keys, a management key always operates
      at the workspace level.
  - name: MCP Gateway
    description: >-
      Register upstream MCP servers, discover and sync their tools, and assemble
      gateways that expose a curated tool surface to MCP clients.
  - name: Model Catalog
    description: >-
      Browse the Toqan Router model catalog: every model Toqan Router offers,
      across every provider, with pricing, capabilities and benchmark data. List
      endpoints only return models that are not deprecated. This API is public,
      requires no authentication, and is rate limited to 120 requests per minute
      per IP. Responses carry a 5-minute cache-control max-age.
  - name: Monitors
    description: >-
      Monitors are custom observability dashboards for traces, runtime metrics,
      and logs. Each monitor holds widgets that chart one telemetry query. List
      the metrics, operations, and dimensions available to your workspace with
      `GET /v3/telemetry/capabilities`, or start from a preset with `GET
      /v2/monitors/presets`.
  - name: Notifiers
    description: Notifier destinations used to send delivery and workflow notifications.
  - name: Routing Rules
    description: >-
      Routing Rules conditionally select models and enforce request plugins for
      AI Gateway traffic. Rules are evaluated by ascending priority and may be
      scoped to a project or the whole workspace.
  - name: Threads
    description: Threads group related trace invocations and their aggregate usage
  - name: Smart Routers
    description: >-
      Create and manage workspace Smart Routers. A Smart Router selects a model
      from an eligible pool for each request according to a quality, balanced,
      or cost profile.
  - name: Responses
  - name: Embeddings
  - description: Beta. Run typed classification questions against a classify model.
    name: Classify
  - description: Beta. Run classification decisions with the classify contract.
    name: Decisions
  - description: >-
      Run large offline workloads as JSONL batches and download
      OpenAI-compatible result files.
    name: Batches
paths:
  /v3/telemetry/query:
    post:
      tags:
        - Telemetry
      summary: Query telemetry
      description: >-
        Canonical neutral query envelope for traces, metrics, and logs. Select a
        source, compute list, and time range; optionally group, filter, bucket,
        sort, limit, and include totals. ReportingService.QueryReport and
        TraceQueryService.AggregateTraces remain supported compatibility
        contracts.
      operationId: TelemetryQuery
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryTelemetryRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryTelemetryResponse'
        '401':
          description: >-
            Authentication required. See
            https://router.toqan.ai/docs/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKey: []
components:
  schemas:
    QueryTelemetryRequest:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/TelemetrySource'
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
        compute:
          type: array
          items:
            $ref: '#/components/schemas/TraceCompute'
        grain:
          type: string
          description: >-
            Empty string and "none" are equivalent: a single row per group
            instead
             of a time series.
        group_by:
          type: array
          items:
            type: string
        filters:
          type: array
          items:
            $ref: '#/components/schemas/TraceFilter'
        filter_operator:
          type: string
        limit:
          type: integer
          description: >-
            Scalar queries: maximum returned rows, default 100. Time-series
            queries: optional maximum number of distinct groups; exceeding it
            fails the query instead of truncating timelines. Time-series results
            are complete within safety budgets of 5000 rows, 5000 buckets, and
            50000 metric values. Queries are limited to 90 days and 30 seconds
            of execution.
          format: int32
        time_zone:
          type: string
        include_totals:
          type: boolean
        mode:
          enum:
            - timeseries
            - scalar
          type: string
          description: >-
            Value shaping. `timeseries` buckets by grain; `scalar` returns one
            row per group. When omitted, grain selects the compatible shape.
        sort:
          enum:
            - desc
            - asc
          type: string
          description: Ordering for scalar/top-list rows. Defaults to `desc`.
        interval_seconds:
          type: integer
          description: >-
            Explicit bucket width in seconds. Takes precedence over `grain` when
            both are set.
          format: int32
        selected_range_seconds:
          type: integer
          description: >-
            The span originally selected, before live extended [from, to).
            `grain:"auto"` resolves bucket width from this span, independent of
            how far [from, to) has since grown.
          format: int32
        project_id:
          type: string
          description: |-
            Pins the read to one project the caller can reach. Omit to keep the
             caller's token scope.
        query:
          type: string
          description: >-
            Free-text trace search, matched like the trace list search. Only for
            source `TRACES` with trace aggregate metrics.
        oql:
          type: string
          description: >-
            OQL trace selection (`fetch traces | ...`), compiled to filters like
            the OQL trace query. Only for source `TRACES` with trace aggregate
            metrics; cannot be combined with `filters` or `query`.
    QueryTelemetryResponse:
      type: object
      properties:
        object:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/TelemetryRow'
        totals:
          $ref: '#/components/schemas/TelemetryRow'
        meta:
          $ref: '#/components/schemas/QueryTelemetryMeta'
        request:
          $ref: '#/components/schemas/QueryTelemetryRequest'
        has_more:
          type: boolean
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
        code:
          type: integer
          description: Numeric error code, when one is available.
        details:
          type: array
          items: {}
          description: Additional error details, when the service reports any.
      required:
        - message
    TelemetrySource:
      type: string
      enum:
        - TELEMETRY_SOURCE_TRACES
        - TELEMETRY_SOURCE_METRICS
        - TELEMETRY_SOURCE_LOGS
    TraceCompute:
      type: object
      properties:
        metric:
          type: string
        op:
          type: string
    TraceFilter:
      type: object
      properties:
        field:
          type: string
        op:
          type: string
        values:
          type: array
          items:
            type: string
    TelemetryRow:
      type: object
      properties:
        timestamp:
          type: string
          description: |-
            Unset when the resolved grain is "none" — one row per group, not a
             time series.
          format: date-time
        group:
          type: object
          additionalProperties:
            type: string
        metrics:
          type: object
          additionalProperties:
            type: number
            format: double
    QueryTelemetryMeta:
      type: object
      properties:
        effective_grain:
          type: string
        warnings:
          type: array
          items:
            type: string
        row_count:
          type: integer
          format: int32
        request_id:
          type: string
        currency:
          type: string
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.