Saltar al contenido principal
GET
Report consumption over a period

Autorizaciones

Authorization
string
header
requerido

Enforced on every transport, with no exempt operation. A person's request must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011 — except a request with no token on a laptop's socket from the OS user the kernel names as the host's own, which is that machine's user.

Parámetros de consulta

from
string<date-time>
requerido

Start of the period, inclusive.

to
string<date-time>
requerido

End of the period, exclusive.

groupBy
enum<string>
predeterminado:model

Grouping dimension. model is the default and the answer an older client that sends none keeps getting. day is the UTC day the round was stamped with, which is the store's own clock and not the caller's. repository is read off the conversation each round ran in, and person is who acted in it. A dimension this version does not serve is refused naming itself.

Opciones disponibles:
model,
day,
repository,
conversation,
person
cursor
string

Opaque pagination cursor from a previous page's nextCursor or prevCursor.

Maximum string length: 1024
limit
integer
predeterminado:25

Maximum items per page.

Rango requerido: 1 <= x <= 100

Respuesta

The usage report.

Consumption over a period, broken down by the requested dimension. One page of it: the rows are ordered by their own group key ascending — the model name, the UTC day, the repository path, the conversation id or the person's subject, whichever was asked for — and the withheld private group, which has no key of its own, comes first. A key is unique per group by construction, so there is no tie to break and the cursor is simply the last key served.

from
string<date-time>
requerido
to
string<date-time>
requerido
groupBy
enum<string>
requerido

The dimension these rows are grouped by, echoed from the request.

Opciones disponibles:
model,
day,
repository,
conversation,
person
rows
object[]
requerido
nextCursor
string

Pass as cursor for the next page, with the same groupBy. A cursor issued for one grouping is refused by another rather than re-interpreted against a key it does not name. Absent on the last page.