---
title: "Get analytics overview"
method: GET
path: "/analytics/overview"
tags: ["Analytics AI — Analytics & BI"]
---

# Get analytics overview

`GET /analytics/overview`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/analytics/overview`
- Auth: HTTP bearer

WHEN TO USE: current operational snapshot of the document estate (counts, storage, DMS distribution, module state). For growth over time, processing rate and top document types use po_bi_dashboard_get instead. Do not call both for the...

## Query parameters

- `period` '7d' | '30d' | '90d' | '365d' | 'all'
- `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
      - `token` string
      - `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
  - `aggregation_scope` object
    - `period` string
    - `workspace_scope` string
    - `workspace_id` string
    - `date_basis` string
    - `scope_contract` string
    - `primary_basis` string
    - `stock_fields_suffix` string
  - `metric_definitions` object
    - `documents.in_period` string
    - `documents.total_all_time` string
    - `partners` string
    - `partners_all_time` string
    - `distinct_publisher_names` string
    - `canonical_partners` string
    - `relations` string
    - `relations_all_time` string
    - `entities` string
    - `entities_all_time` string
    - `embeddings` string
    - `embeddings_all_time` string
    - `dms_intelligence.processed_pct` string
    - `dms_intelligence.not_searchable_pct` string
    - `dms_intelligence.embedding_searchable_pct` string
    - `dms_intelligence.embedding_not_searchable_pct` string
  - `metrics_scope` string
  - `overview` object
    - `documents` object
      - `in_period` integer
      - `pages_in_period` integer
      - `total_all_time` integer
      - `total` integer
      - `total_pages_all_time` integer
      - `total_pages` integer
      - `total_storage_gb` number
      - `file_storage_gb` integer
      - `extra_storage_gb` number
      - `storage_definition` string
      - `storage_basis` string
      - `avg_file_size_mb` number
    - `workspaces` integer
    - `workspaces_active_in_period` integer
    - `workspaces_details` object
      - `total` integer
      - `by_type` object
        - `folder` integer
        - `standard` integer
    - `partners` integer
    - `distinct_publisher_names` integer
    - `partners_all_time` integer
    - `distinct_publisher_names_all_time` integer
    - `relations` integer
    - `relations_all_time` integer
    - `entities` integer
    - `entities_all_time` integer
    - `entities_details` object
      - `total` integer
      - `by_type` unknown[]
        - unknown
    - `entities_details_all_time` object
      - `total` integer
      - `by_type` unknown[]
        - unknown
    - `embeddings` integer
    - `embeddings_all_time` integer
    - `embeddings_details` object
      - `total` integer
      - `dimensions` integer
      - `model` string
      - `by_type` unknown[]
        - unknown
      - `total_vectors_size_mb` integer
    - `embeddings_details_all_time` object
      - `total` integer
      - `dimensions` integer
      - `model` string
      - `by_type` object
        - `document_summary` integer
        - `metadata` integer
        - `contextual` integer
        - `contextual_summary` integer
        - `parent` integer
      - `total_vectors_size_mb` number
    - `dms_distribution` unknown[]
      - unknown
    - `dms_distribution_all_time` object[]
      - `tier` string
      - `label` string
      - `label_de` string
      - `count` integer
    - `dms_intelligence` object
      - `period` object
        - `document_count` integer
        - `storage_only_count` integer
        - `ai_dms_basic_count` integer
        - `ai_dms_premium_count` integer
        - `ai_dms_ultra_count` integer
        - `processed_count` integer
        - `processed_pct` integer
        - `intelligence_score` integer
        - `not_searchable_pct` integer
        - `not_searchable_pct_basis` string
        - `documents_with_embeddings` integer
        - `embedding_searchable_pct` integer
        - `embedding_not_searchable_pct` integer
        - `embedding_coverage_basis` string
      - `all_time` object
        - `document_count` integer
        - `storage_only_count` integer
        - `ai_dms_basic_count` integer
        - `ai_dms_premium_count` integer
        - `ai_dms_ultra_count` integer
        - `processed_count` integer
        - `processed_pct` integer
        - `intelligence_score` integer
        - `not_searchable_pct` integer
        - `not_searchable_pct_basis` string
        - `documents_with_embeddings` integer
        - `embedding_searchable_pct` integer
        - `embedding_not_searchable_pct` integer
        - `embedding_coverage_basis` string
  - `period` 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)