curl --request GET \
--url https://ndi-api.nace.ai/v1/usage/overview \
--header 'X-API-Key: <api-key>'{
"active_jobs": 123,
"avg_processing_seconds": 123,
"avg_processing_seconds_prior": 123,
"documents_processed": 123,
"documents_processed_prior": 123,
"period_end": "2023-12-25",
"period_start": "2023-12-25",
"queued_jobs": 123,
"series": [
{
"day": "2023-12-25",
"documents": 123
}
],
"window": "7d"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}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.
curl --request GET \
--url https://ndi-api.nace.ai/v1/usage/overview \
--header 'X-API-Key: <api-key>'{
"active_jobs": 123,
"avg_processing_seconds": 123,
"avg_processing_seconds_prior": 123,
"documents_processed": 123,
"documents_processed_prior": 123,
"period_end": "2023-12-25",
"period_start": "2023-12-25",
"queued_jobs": 123,
"series": [
{
"day": "2023-12-25",
"documents": 123
}
],
"window": "7d"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
Query Parameters
Rolling window ending today (UTC): 7, 30, or 90 days.
7d, 30d, 90d Response
Successful Response
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.
Show child attributes
Show child attributes
7d, 30d, 90d