Skip to main content
GET
Get endpoint usage history for authorized partner tenants.

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token, carrying subject_type=machine_client and the pulse.read scope.

Scopes

pulse.read

Query Parameters

tenant_ids
string

Comma-separated tenant ids to read. Every id must be inside the caller's authorized scope, otherwise 403 tenant_out_of_scope. Omit it to read every authorized tenant.

from
string
required

Required. First day of the range, yyyy-MM-dd. Must not be later than to.

to
string
required

Required. Last day of the range, yyyy-MM-dd.

grain
enum<string>

The bucket size: day (the default) or month. Anything else returns 400 invalid_grain.

Available options:
day,
month

Response

The usage history for the covered tenants.

Endpoint usage history over a date range.

root_tenant_id
string<uuid>
required

The top of the caller's authorized scope.

grain
string
required

The bucket size the items are in: day or month.

from
string<date>
required

First day of the range, as requested.

to
string<date>
required

Last day of the range, as requested.

coverage
object[]
required

The tenants the history was read from.

items
object[]
required

One item per tenant and period. A tenant with no history in a period has no item for it.