---
title: "Get Document Usage"
method: POST
path: "/usage/documents"
tags: ["Usage"]
---

# Get Document Usage

`POST /usage/documents`

Document usage analytics (added/deleted/parsed/indexed events).

## Request body

- UsageRequest
  - `start_time` integer, required — Start time for the usage query (inclusive) - Unix timestamp (seconds since epoch)
  - `end_time` integer, required — End time for the usage query (inclusive) - Unix timestamp (seconds since epoch)
  - `aggregation_window` 'minutely' | 'hourly' | 'daily', required
  - `collection_names` string[], nullable — Optional list of collection names to filter by. If None, returns data for all collections.

## Response `200`

Successful Response

- DocumentUsageResponse[]
  - `window_start` integer, required
  - `organization_id` string, uuid, required
  - `collection_id` string, uuid, required
  - `event_type` 'added' | 'deleted' | 'parsed' | 'indexed', required
  - `event_count` integer, required
  - `total_file_size_bytes` integer, required
  - `total_content_tokens` integer, required
  - `total_llm_tokens` integer, required
  - `total_embedding_tokens` integer, required
  - `total_coarse_chunks` integer, required
  - `total_fine_chunks` integer, required
  - `total_pages` integer, required
  - `total_time_taken_ms` number, required

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Validation Error

## Changes

- **2026-01-21** `b5badb138367` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/changes/usage/documents/post.md)

---

[API](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api.md) · [All operations](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zeroentropy-ai/zeroentropy-api/revisions/5ff1b24060b9/schema)
