> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Query reporting metrics > Returns time-series, scalar, and top-list analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. **Related guide**: Traces guide. See the [Traces guide](/ai-studio/observability/traces) for a walkthrough with examples. ## OpenAPI ````yaml post /v2/reporting openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - 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: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API 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: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - 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: Hub description: Hub items are reusable templates available to a 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 orq.ai model catalog: every model orq 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: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - 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: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - 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: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is called from a user session during onboarding; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - 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. - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Search Gateway with managed credits or BYOK. name: Web Search externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/reporting: post: tags: - Reporting summary: Query reporting metrics description: >- Returns time-series, scalar, and top-list analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. operationId: ReportingQuery requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryReportRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QueryReportResponse' components: schemas: QueryReportRequest: required: - metric - from - to type: object properties: metric: enum: - genai.requests - genai.tokens - genai.cost - genai.errors - genai.error_rate - genai.latency.p50 - genai.latency.p95 - genai.latency.p99 - genai.ttft.avg - genai.ttft.p50 - genai.ttft.p95 - genai.evaluator.runs - genai.evaluator.pass_rate - genai.evaluator.score.avg - genai.guardrail.runs - genai.guardrail.block_rate - genai.guardrail.triggered - genai.usage type: string description: Catalogue metric to query. from: type: string description: Inclusive lower bound for the report window (RFC 3339, UTC). format: date-time to: type: string description: Exclusive upper bound for the report window (RFC 3339, UTC). format: date-time grain: enum: - auto - minute - hour - day type: string description: >- Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range. group_by: type: array items: type: string enum: - project - identity - provider - model - product - api_key - status_code - http_status_code - credential_type - dimension - dimension_type - tag - agent - tool - deployment - evaluator - dataset - prompt - policy - conversation - thread - memory_store - knowledge - sheet - guardrail_origin - evaluator_name - evaluator_type - evaluator_version - result_type - evaluation_stage - guardrail_stage - evaluator_stage - guardrail_action - result_label description: >- Reporting dimensions to break down by. Valid dimensions depend on the selected metric. filters: type: array items: $ref: '#/components/schemas/Filter' description: Up to 20 allowlisted predicates combined with AND. limit: type: integer description: |- Maximum bucket rows returned. Defaults to 1000 and is capped at 5000. format: int32 time_zone: type: string description: |- IANA time zone applied to bucket boundaries, for example `America/New_York`. Response timestamps remain UTC. Empty means UTC. include_totals: type: boolean description: |- When true, include a `totals` block aggregated across the full report window. mode: enum: - timeseries - scalar type: string description: >- Value shaping. `timeseries` (default) buckets by time; `scalar` returns one aggregated row per group over the whole window, ordered by value (top list), or a single row when `group_by` is empty. sort: enum: - desc - asc type: string description: >- Value ordering for `scalar` rows. Defaults to `desc`. Ignored for `timeseries`. QueryReportResponse: type: object properties: object: enum: - report type: string description: >- Object discriminator for typed SDKs and JSON parsers; always `report`. request: allOf: - $ref: '#/components/schemas/QueryReportRequest' description: |- The request that produced this response, parroted back so caller code never has to remember its own payload to interpret the result. data: type: array items: $ref: '#/components/schemas/DataPoint' description: Time-ordered buckets. totals: allOf: - $ref: '#/components/schemas/Totals' description: |- Totals across the whole window. Present only when `include_totals=true` on the request. has_more: type: boolean description: |- Pagination contract. Always populated; currently false because the server caps the response at `limit` instead of issuing cursors. meta: allOf: - $ref: '#/components/schemas/ResponseMeta' description: Diagnostic metadata. Filter: type: object properties: field: enum: - project - identity - provider - model - product - api_key - status_code - http_status_code - credential_type - billing_billable - dimension - dimension_type - tag - agent - tool - deployment - evaluator - dataset - prompt - policy - conversation - thread - memory_store - knowledge - sheet - guardrail_origin - evaluator_name - evaluator_type - evaluator_version - result_type - evaluation_stage - guardrail_stage - evaluator_stage - guardrail_action - result_label type: string description: >- Public reporting dimension to filter on. Valid fields depend on the selected metric. op: enum: - eq - neq - in - not_in type: string description: >- Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values. values: type: array items: type: string description: |- Values compared against the selected field. Values are interpreted as public API strings, not SQL fragments. DataPoint: type: object properties: timestamp: type: string description: |- Bucket start in UTC, RFC 3339. Clients that need epoch milliseconds can derive them from this value. Unset for `mode=scalar` rows, which aggregate the whole window. format: date-time dimensions: type: object additionalProperties: type: string description: |- Public breakdown labels for this bucket, keyed by group-by column. Empty when no group-by was requested. Empty values are omitted so the caller never has to special-case `""`. metrics: type: object additionalProperties: type: number format: double description: |- Metric values for this bucket. Single-metric requests carry one entry keyed by the requested metric name (e.g. `"genai.cost"` → `0.000495`). Bundle metrics carry one entry per field. Numbers are pre-rounded to 10 significant digits to avoid IEEE-754 display noise like `0.00009900000000000001`. Totals: type: object properties: metrics: type: object additionalProperties: type: number format: double description: |- Same shape and rules as `DataPoint.metrics`, aggregated across the whole window. ResponseMeta: type: object properties: effective_grain: enum: - minute - hour - day type: string description: >- Bucket grain actually applied. Differs from the requested value when `grain=auto`. row_count: type: integer description: |- Number of rows in `data`. Cheap hint for clients that paginate client-side; mirrors `len(data)`. format: int32 request_id: type: string description: |- Stable identifier for this query. Forward in support tickets so server logs can be correlated. Also returned in the `X-Request-Id` response header. currency: enum: - USD type: string description: ISO 4217 currency code for cost fields. Always `USD` today. warnings: type: array items: type: string description: >- Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.