usage

Metered usage for the authenticated organization

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.

get/api/v1/usage

Request

Base URL
https://platform-api.transform.unstructured.io (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/unstructured/apis/platform-api/docs/api/v1/usage/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

start_datestring date required

First UTC day to include, inclusive.

end_datestring date required

Last UTC day to include, inclusive.

Headers

unstructured-api-keystring nullable

Response

Successful Response

org_idinteger required

start_datestring date required

end_datestring date required

complete_throughstring 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_unitsstring[]

Units present in this response.

Changes

No recorded changes to this operation across all 1 revision of this API.