---
title: "Metered usage for the authenticated organization"
method: GET
path: "/api/v1/usage"
tags: ["usage"]
---

# Metered usage for the authenticated organization

`GET /api/v1/usage`

## Request

- Base URL: `https://platform.unstructuredapp.io`
- URL: `https://platform.unstructuredapp.io/api/v1/usage`
- Auth: none declared

Daily metered consumption, grouped by action SKU and unit.

Reports consumption, not spend: there is no cost or price field, and pricing is applied outside the platform. Quantities are only comparable within a unit, which is why totals are returned per unit rather than as a single number.

Scoped to the organization behind the credential; there is no organization parameter.

Call this endpoint at most 15 times per minute for each authenticated identity.

## Query parameters

- `start_date` string, date, required: First UTC day to include, inclusive.
- `end_date` string, date, required: Last UTC day to include, inclusive.

## Headers

- `unstructured-api-key` string, nullable

## Response `200`

Successful Response

- UsageResponse
  - `org_id` integer, required
  - `start_date` string, date, required
  - `end_date` string, date, required
  - `complete_through` string, date, nullable: Last day in the range with a finished rollup. Days after this are partial or absent; null means no day in the range has been rolled up yet.
  - `observed_units` string[]: Units present in this response.
  - `days` UsageDay[]
    - `day` string, date, required
    - `measures` UsageMeasure[]
      - `action_sku` string, required: What was metered, e.g. `partition.vlm`, `embed.tokens`, `tokens.input`.
      - `unit` string, required: Unit of `quantity`, e.g. `pages`, `tokens`, `count`, `bytes`, `milliseconds`. Quantities are only comparable within a unit.
      - `quantity` integer, required: Summed quantity for this sku and unit.
      - `record_count` integer, required: Number of underlying usage records.
      - `distinct_items` integer, required: Distinct documents, identified by a hash. Summed across days, so a document processed on two days counts twice.
      - `distinct_job_ids` integer, required: Distinct jobs, summed across days on the same basis as `distinct_items`.
  - `totals` UsageMeasure[]: Range totals per (action_sku, unit). A list, not a scalar, because units are not addable.
    - `action_sku` string, required: What was metered, e.g. `partition.vlm`, `embed.tokens`, `tokens.input`.
    - `unit` string, required: Unit of `quantity`, e.g. `pages`, `tokens`, `count`, `bytes`, `milliseconds`. Quantities are only comparable within a unit.
    - `quantity` integer, required: Summed quantity for this sku and unit.
    - `record_count` integer, required: Number of underlying usage records.
    - `distinct_items` integer, required: Distinct documents, identified by a hash. Summed across days, so a document processed on two days counts twice.
    - `distinct_job_ids` integer, required: Distinct jobs, summed across days on the same basis as `distinct_items`.

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-16** `37954f8df5b3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/unstructuredapp/apis/platform-api/changes/api/v1/usage/get.md)

---

[API](https://skmtc.dev/unstructuredapp/apis/platform-api.md) - [All operations](https://skmtc.dev/unstructuredapp/apis/platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unstructuredapp/apis/platform-api/revisions/94fb718d49fe?raw)