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

# Get document trends

`GET /analytics/trends`

## Request

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

Time-based trends — upload volume, processed pages, storage growth, and related metrics over a selectable period. Parameterize with period (e.g. 7d, 30d, 1y) and optional workspace_id for scoped tenants. Permissions: Requires Analytics...

## Query parameters

- `period` '7d' | '30d' | '90d' | '365d' | 'all'
- `group_by` 'day' | 'week' | 'month'
- `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
    - `stock_count_basis` string
    - `stock_count_excludes` unknown[]
      - unknown
    - `upload_counts_note` string
  - `group_by` string
  - `period` string
  - `processing_time` string
  - `status` string
  - `trends` object
    - `uploads` unknown[]
      - unknown
    - `dms_processing` unknown[]
      - unknown
    - `dms_processing_by_period` unknown[]
      - unknown

## 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)