Every usage event, oldest first: a page at a time, or all as CSV or NDJSON

GET

/v1/admin/usage

curl --request GET \
  --url 'https://example.com/v1/admin/usage?format=json' \
  --header 'Authorization: Bearer <token>'

Authorizations

• adminToken

Parameters

Query Parameters

tenant

string

Only this tenant’s events.

from

string

At or after this day or time.

to

string

Before this day or time.

format

string

Allowed values: json csv ndjson

Json (a page at a time), or every event as csv or ndjson.

limit

integer

>= 1 <= 200

At most this many (1 to 200, 50 by default).

cursor

string

The page after the one whose next this is.

Responses

200

The answer.

object

metering

required

string

items

required

Array<object>

object

id

required

string

at

required

string

tenant

required

string

key

required

string

source

required

string

kind

required

string

job

required

null | string

batch

required

null | string

template

required

null | string

version

required

null | integer

tier

required

string | null

pages

required

integer | null

bytes

required

integer | null

images

required

null | integer

dpi

required

null | integer

waitMs

required

integer | null

renderMs

required

integer | null

outcome

required

string

requestId

required

string | null

details

object

next

required

Example ^generated

{
  "metering": "example",
  "items": [
    {
      "id": "example",
      "at": "example",
      "tenant": "example",
      "key": "example",
      "source": "example",
      "kind": "example",
      "job": "example",
      "batch": "example",
      "template": "example",
      "version": 1,
      "tier": "example",
      "pages": 1,
      "bytes": 1,
      "images": 1,
      "dpi": 1,
      "waitMs": 1,
      "renderMs": 1,
      "outcome": "example",
      "requestId": "example",
      "details": {}
    }
  ],
  "next": "example"
}

With format=csv: a header line, then an event a line.

string

With format=ndjson: an event a line, as JSON.

string

Example ^generated

example

400

The request is malformed (bad-request).

Media typeapplication/json

object

code

required

string

Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing

message

required

string

requestId

string

Example

{
  "code": "field-unknown"
}

401

No key, or not a valid one.

Media typeapplication/json

object

code

required

string

Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing

message

required

string

requestId

string

Example

{
  "code": "field-unknown"
}

403

The key lacks the scope, or its tenant is suspended or deleted.

Media typeapplication/json

object

code

required

string

Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing

message

required

string

requestId

string

Example

{
  "code": "field-unknown"
}