> ## Documentation Index > Fetch the complete documentation index at: https://docs.ndi.nace.ai/llms.txt > Use this file to discover all available pages before exploring further. # get_usage_overview > Dashboard figures for documents processed, in-flight jobs, and latency. Cost class: fast. Documents are succeeded document-operation jobs (parse / split / classify / categorize / extract / ground / qa_file) finished in the window. Active and queued counts are a point-in-time snapshot of every job kind. The series is zero-filled so a chart can plot it without filling gaps. ## OpenAPI ````yaml /openapi.json get /v1/usage/overview openapi: 3.1.0 info: description: >- Document intelligence: parse, split, classify, extract, and ground files, or build a searchable workspace. Authenticate with ``X-API-Key``. title: NDI Platform API version: 0.1.0 servers: - url: https://ndi-api.nace.ai security: [] tags: [] paths: /v1/usage/overview: get: tags: - operations summary: get_usage_overview description: |- Dashboard figures for documents processed, in-flight jobs, and latency. Cost class: fast. Documents are succeeded document-operation jobs (parse / split / classify / categorize / extract / ground / qa_file) finished in the window. Active and queued counts are a point-in-time snapshot of every job kind. The series is zero-filled so a chart can plot it without filling gaps. operationId: get_usage_overview_v1_usage_overview_get parameters: - description: 'Rolling window ending today (UTC): 7, 30, or 90 days.' in: query name: window required: false schema: default: 7d description: 'Rolling window ending today (UTC): 7, 30, or 90 days.' enum: - 7d - 30d - 90d title: Window type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageOverviewResponse' description: Successful Response '504': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Gateway Timeout default: content: application/json: example: error: code: invalid_request detail: null message: >- Request body has extra fields that this operation does not accept. request_id: req-01j9k2n3p4q5r6s7t8v9 retryable: false schema: $ref: '#/components/schemas/ErrorEnvelope' description: >- Typed error envelope used by every 4xx and 5xx. ``error.code`` distinguishes the failure; HTTP status is a consequence of the code. security: - APIKeyHeader: [] components: schemas: UsageOverviewResponse: additionalProperties: false description: |- Dashboard figures for a rolling ``7d`` / ``30d`` / ``90d`` window. Prior-period fields are the same-length window immediately before ``period_start``. The frontend derives the percentage / delta; this response only reports the two raw values. Average processing time is ``null`` when the window has no succeeded document-operation jobs. properties: active_jobs: title: Active Jobs type: integer avg_processing_seconds: anyOf: - type: number - type: 'null' title: Avg Processing Seconds avg_processing_seconds_prior: anyOf: - type: number - type: 'null' title: Avg Processing Seconds Prior documents_processed: title: Documents Processed type: integer documents_processed_prior: title: Documents Processed Prior type: integer period_end: format: date title: Period End type: string period_start: format: date title: Period Start type: string queued_jobs: title: Queued Jobs type: integer series: items: $ref: '#/components/schemas/UsageOverviewPoint' title: Series type: array window: enum: - 7d - 30d - 90d title: Window type: string required: - window - period_start - period_end - documents_processed - documents_processed_prior - active_jobs - queued_jobs - avg_processing_seconds - avg_processing_seconds_prior - series title: UsageOverviewResponse type: object ErrorEnvelope: description: Every non-2xx body on ``/v1``. example: error: code: invalid_request detail: null message: Request body has extra fields that this operation does not accept. request_id: req-01j9k2n3p4q5r6s7t8v9 retryable: false properties: error: $ref: '#/components/schemas/Error' required: - error title: ErrorEnvelope type: object UsageOverviewPoint: additionalProperties: false description: One calendar day in the usage-overview series. properties: day: format: date title: Day type: string documents: title: Documents type: integer required: - day - documents title: UsageOverviewPoint type: object Error: description: The error object, per spec 12 §1.8. properties: code: $ref: '#/components/schemas/ErrorCode' detail: anyOf: - additionalProperties: true type: object - type: 'null' description: Structured payload, when the code carries one. title: Detail message: description: Human- and model-readable; says what to do differently. title: Message type: string request_id: description: Per-request correlation id; matches the ``X-Request-Id`` header. title: Request Id type: string retryable: description: Whether retrying the identical request could succeed. title: Retryable type: boolean required: - code - message - retryable - request_id title: Error type: object ErrorCode: description: |- Every error the ``/v1`` surface can return. Clients must treat this as an **open** enum: a new member is an additive change (spec 12 §9), and a client that crashes on an unknown code makes every future error a breaking change. enum: - invalid_request - unsupported_file_type - file_too_large - invalid_schema - invalid_sql - invalid_path_prefix - command_not_permitted - batch_too_large - domain_validation_failed - default_label_required - wait_required_for_zero_retention - workspace_not_found - file_not_found - job_not_found - upload_not_found - node_not_found - schema_not_found - domain_not_found - session_not_found - access_label_not_found - path_conflict - schema_version_conflict - access_label_name_taken - workspace_name_taken - access_label_in_use - upload_expired - file_not_ingested - workspace_deleting - workspace_not_deletable - ingestion_in_progress - job_not_cancellable - confirmation_required - domain_not_published - domain_in_use - reserved_domain_slug - kg_not_built - kg_build_in_progress - session_busy - range_not_satisfiable - result_expired - access_denied - access_backstop_violation - access_mode_not_implemented - rate_limited - concurrency_limit_reached - quota_exceeded - corrupt_file - zero_byte_file - encrypted_file - parse_failed - ocr_failed - conversion_failed - sheetless_workbook - unplayable_media - unclassified_pages - job_cancelled - job_timeout - upstream_unavailable - internal_error - unauthorized - not_implemented title: ErrorCode type: string securitySchemes: APIKeyHeader: in: header name: X-API-Key type: apiKey ````