Skip to main content
GET
/
v1
/
stats
/
overview
Get stats overview
curl --request GET \
  --url http://localhost:8000/v1/stats/overview \
  --header 'Authorization: Bearer <token>'
{
  "documents": {
    "total": 123,
    "total_pages": 123,
    "total_size_bytes": 123
  },
  "jobs": {
    "total": 123,
    "by_status": {
      "pending": 0,
      "processing": 0,
      "completed": 0,
      "failed": 0
    }
  },
  "schemas": {
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Response

High-level summary of documents, jobs, and schemas

Response for stats overview (GET /v1/stats/overview).

High-level dashboard summary with counts for documents, jobs, and schemas.

​
documents
DocumentStats · object
required

Document statistics

Example:
{
  "total": 1247,
  "total_pages": 48923,
  "total_size_bytes": 2147483648
}
​
jobs
JobStats · object
required

Job statistics

Example:
{
  "by_status": {
    "completed": 1489,
    "failed": 19,
    "pending": 12,
    "processing": 3
  },
  "total": 1523
}
​
schemas
SchemaStats · object
required

Schema statistics

Example:
{ "total": 8 }