---
title: "get_usage_overview"
method: GET
path: "/v1/usage/overview"
tags: ["operations"]
---

# get_usage_overview

`GET /v1/usage/overview`

## Request

- Base URL: `https://ndi-api.nace.ai`
- URL: `https://ndi-api.nace.ai/v1/usage/overview`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/nace/apis/ndi-platform-api/docs/v1/usage/overview/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `window` '7d' | '30d' | '90d': Rolling window ending today (UTC): 7, 30, or 90 days.

## Response `200`

Successful Response

- UsageOverviewResponse: 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.
  - `active_jobs` integer, required
  - `avg_processing_seconds` number, nullable, required
  - `avg_processing_seconds_prior` number, nullable, required
  - `documents_processed` integer, required
  - `documents_processed_prior` integer, required
  - `period_end` string, date, required
  - `period_start` string, date, required
  - `queued_jobs` integer, required
  - `series` UsageOverviewPoint[], required
    - `day` string, date, required
    - `documents` integer, required
  - `window` '7d' | '30d' | '90d', required

## Other responses

- `504`: Gateway Timeout
- `default`: Typed error envelope used by every 4xx and 5xx. ``error.code`` distinguishes the failure; HTTP status is a consequence of the code.

---

[API](https://skmtc.dev/nace/apis/ndi-platform-api.md) - [All operations](https://skmtc.dev/nace/apis/ndi-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nace/apis/ndi-platform-api/revisions/d002a3589a67?raw)