> ## Documentation Index > Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt > Use this file to discover all available pages before exploring further. # Read service metrics for a bounded time window with explicit coverage information. > Read service metrics for a bounded time window with explicit coverage information. The request is scoped to the authenticated RevoEngine instance and operation policy. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/observability/overview/query openapi: 3.0.0 info: title: RevoEngine Platform API description: Official RevoEngine Platform API documentation. version: 1.6.4 contact: name: Support email: support@revoengine.com termsOfService: https://docs.revoengine.com/tos servers: - url: https://api.revoengine.com description: Production security: [] tags: - name: Accounts description: Users, service accounts, API keys, status, and platform access. externalDocs: description: Identity and access guide url: https://docs.revoengine.com/operate/identity-and-access - name: Activity description: Snapshot-backed activity and version history. externalDocs: description: Observability guide url: https://docs.revoengine.com/operate/observability - name: Agent Memory description: Administrative access to durable Agent memory. externalDocs: description: Agent memory and workspaces guide url: https://docs.revoengine.com/ai/memory-and-workspaces - name: Agent Plugins description: Agent plugin definitions, synchronization, testing, and lifecycle. externalDocs: description: Agent plugins guide url: https://docs.revoengine.com/ai/plugins - name: Agent Terminals description: Terminal pairing, owner grants, access, and command activity. externalDocs: description: Connect a terminal guide url: https://docs.revoengine.com/ai/terminals - name: Agents description: >- Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and lifecycle. externalDocs: description: Autonomous Agents guide url: https://docs.revoengine.com/ai/agents - name: Assistant description: >- Assistant threads, messages, responses, goals, reports, sharing, attachments, and control. externalDocs: description: Assistant guide url: https://docs.revoengine.com/ai/assistant - name: Automation description: >- Jobs, templates, schedules, events, webhooks, execution history, and lifecycle. externalDocs: description: Automation guide url: https://docs.revoengine.com/operate/automation - name: Chat description: Collaborative chat threads, messages, reactions, uploads, and attachments. externalDocs: description: Team Chat guide url: https://docs.revoengine.com/operate/chat - name: Component deployments description: >- Custom Node.js runtime deployment attempts, readiness, activation, and rollback. externalDocs: description: Custom Node.js guide url: https://docs.revoengine.com/build/custom-nodejs - name: Components description: Components, elements, versions, validation, activation, and lifecycle. externalDocs: description: Components guide url: https://docs.revoengine.com/build/components - name: Config description: Instance configuration, usage, logs, and cache administration. externalDocs: description: Instance settings guide url: https://docs.revoengine.com/platform/instance-settings - name: Database Cache description: Instance Database cache values and statistics. externalDocs: description: Database Cache guide url: https://docs.revoengine.com/operate/database-cache - name: Database Views description: Database Views, previews, refreshes, exports, and controlled data actions. externalDocs: description: Database Views guide url: https://docs.revoengine.com/operate/database-views - name: Databases description: Database definitions, data, audits, exports, cloning, and lifecycle. externalDocs: description: Databases guide url: https://docs.revoengine.com/operate/databases - name: Endpoints description: >- Endpoint definitions, activation, validation, generated OpenAPI, and statistics. externalDocs: description: Endpoints guide url: https://docs.revoengine.com/operate/endpoints - name: Files description: Compatibility file listing, preview, download, and deletion operations. externalDocs: description: Files compatibility guide url: https://docs.revoengine.com/operate/files - name: Groups description: Groups, membership, avatars, and lifecycle. externalDocs: description: Groups guide url: https://docs.revoengine.com/operate/groups - name: Instance Vault description: Operations in the Instance Vault Platform API domain. externalDocs: description: Secrets and Vault guide url: https://docs.revoengine.com/operate/secrets - name: Me description: Current user profile, keys, avatar, and session information. externalDocs: description: Authentication guide url: https://docs.revoengine.com/developers/authentication - name: Observability description: Authorized execution, performance, graph, and log evidence. externalDocs: description: Observability guide url: https://docs.revoengine.com/operate/observability - name: Preferences description: User and instance preference values. externalDocs: description: Platform UI guide url: https://docs.revoengine.com/platform/ui-tour - name: Role Groups description: Role groups, members, assigned roles, and lifecycle. externalDocs: description: Permissions guide url: https://docs.revoengine.com/operate/permissions - name: Roles description: Available platform roles and role details. externalDocs: description: Permissions guide url: https://docs.revoengine.com/operate/permissions - name: Search description: Cross-domain search over objects visible to the caller. externalDocs: description: Search and discovery guide url: https://docs.revoengine.com/platform/search - name: Secrets description: >- Secret definitions, revision history, explicit rotation, activation, reveal, disable, and destruction. externalDocs: description: Secrets guide url: https://docs.revoengine.com/operate/secrets - name: Share description: >- Short-lived authenticated links to supported application routes and grid state. externalDocs: description: Platform API share-link guide url: >- https://docs.revoengine.com/developers/platform-api#share-application-context - name: Storage description: >- Storage workspaces, folders, objects, upload sessions, signed access, and lifecycle. externalDocs: description: Storage guide url: https://docs.revoengine.com/operate/storage externalDocs: description: Documentation url: https://docs.revoengine.com paths: /api/v1/observability/overview/query: post: tags: - Observability summary: >- Read service metrics for a bounded time window with explicit coverage information. description: >- Read service metrics for a bounded time window with explicit coverage information. The request is scoped to the authenticated RevoEngine instance and operation policy. operationId: ObservabilityController_overview parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ObservabilityQueryDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ObservabilityOverviewDto' security: - bearer: [] components: schemas: ObservabilityQueryDto: type: object properties: from: type: string description: UTC inclusive lower bound. Defaults to the preceding 24 hours. to: type: string description: >- UTC exclusive upper bound. Defaults to now. A single query may cover at most 7 days. filter: $ref: '#/components/schemas/ObservabilityFilterDto' pageSize: type: number default: 100 minimum: 1 maximum: 200 investigationId: type: string description: Opaque investigation budget identifier returned by this API. ObservabilityOverviewDto: type: object properties: nextCursor: type: string nullable: true resources: type: array items: $ref: '#/components/schemas/ObservabilityMetricDto' services: type: array items: $ref: '#/components/schemas/ObservabilityMetricDto' series: type: array items: $ref: '#/components/schemas/ObservabilitySeriesDto' meta: $ref: '#/components/schemas/ObservabilityMetaDto' required: - nextCursor - resources - services - series - meta ObservabilityFilterDto: type: object properties: severities: maxItems: 8 type: array items: type: string events: maxItems: 32 type: array items: type: string nodeId: type: string minLength: 1 maxLength: 192 services: maxItems: 16 type: array items: type: string kinds: maxItems: 16 type: array items: type: string outcomes: type: array maxItems: 4 items: type: string enum: - SUCCESS - ERROR - RUNNING - UNKNOWN resourceIds: maxItems: 32 type: array items: type: string actorIds: maxItems: 32 type: array items: type: string operationId: type: string executionId: type: string rootExecutionId: type: string search: type: string description: Literal case-insensitive text match, up to 128 characters. ObservabilityMetricDto: type: object properties: histogram: type: array items: $ref: '#/components/schemas/ObservabilityDurationBinDto' durationCount: type: number durationSumMs: type: number peakRpm: type: number nullable: true resourceName: type: string nullable: true service: type: string kind: type: string resourceId: type: string nullable: true requests: type: number successes: type: number errors: type: number running: type: number unknown: type: number averageMs: type: number nullable: true p50Ms: type: number nullable: true p95Ms: type: number nullable: true p99Ms: type: number nullable: true percentileApproximate: type: boolean required: - histogram - durationCount - durationSumMs - peakRpm - resourceName - service - kind - resourceId - requests - successes - errors - running - unknown - averageMs - p50Ms - p95Ms - p99Ms - percentileApproximate ObservabilitySeriesDto: type: object properties: histogram: type: array items: $ref: '#/components/schemas/ObservabilityDurationBinDto' durationCount: type: number durationSumMs: type: number peakRpm: type: number nullable: true resourceName: type: string nullable: true service: type: string kind: type: string resourceId: type: string nullable: true requests: type: number successes: type: number errors: type: number running: type: number unknown: type: number averageMs: type: number nullable: true p50Ms: type: number nullable: true p95Ms: type: number nullable: true p99Ms: type: number nullable: true percentileApproximate: type: boolean time: type: string required: - histogram - durationCount - durationSumMs - peakRpm - resourceName - service - kind - resourceId - requests - successes - errors - running - unknown - averageMs - p50Ms - p95Ms - p99Ms - percentileApproximate - time ObservabilityMetaDto: type: object properties: snapshotAt: type: string from: type: string to: type: string source: type: string enum: - NORMALIZED - LEGACY coverage: type: string enum: - COMPLETE - PARTIAL - UNAVAILABLE warnings: type: array items: type: string bytesProcessed: type: number maximumBytesBilled: type: number investigationId: type: string projectionWatermark: type: string nullable: true required: - snapshotAt - from - to - source - coverage - warnings - bytesProcessed - maximumBytesBilled - investigationId - projectionWatermark ObservabilityDurationBinDto: type: object properties: upperMs: type: number count: type: number required: - upperMs - count securitySchemes: bearer: scheme: bearer bearerFormat: JWT description: Bearer JWT token or API Key (sk-*). type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.