---
title: "Get DMS statistics"
method: GET
path: "/documents/stats"
tags: ["Document AI — DMS"]
---

# Get DMS statistics

`GET /documents/stats`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/stats`
- Auth: HTTP bearer

po_documents_stats_get: Get global DMS statistics — total documents, entities, embeddings, breakdown by document type, total amounts. Optionally filtered by workspace. Keywords: statistics, stats, overview, count, total.

## Query parameters

- `workspace_id` number

## Response `200`

Success

- object
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `data` object
    - `total_documents` integer
    - `stock_document_count` integer
    - `stock_count_basis` string
    - `authoritative_document_count` integer
    - `total_embeddings` integer
    - `total_entities` integer
    - `by_document_type` object[]
      - `document_type` string
      - `count` integer
    - `type_source` string
    - `canonical_map` string
    - `metric_definitions` object
      - `by_document_type` string
      - `unclassified` string
      - `stock_document_count` string
    - `aggregation_scope` string
    - `by_document_type_sum` integer
    - `by_type_sum_matches_total` boolean
    - `count_reconciles_with_total` boolean
    - `best_effort_amount_observed` integer
    - `best_effort_amount_observed_note` string
    - `total_amount` integer
    - `total_amount_scope` string
    - `financial_scope` string
  - `processing_time` string
  - `status` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)