Skip to main content
GET
Get discrepancy report usage (Beta)

Authorizations

x-api-key
string
header
required

Headers

x-topograph-workspace-id
string

Workspace whose register credentials file the report. Defaults to the default workspace.

Response

Usage in the current period

used
number
required

Reports counted in the current period. Failed reports are not counted: nothing was filed.

Example:

12

limit
number

Reports allowed in the current period by your subscription. Absent when no allowance applies.

Example:

50

remaining
number

Reports left in the current period. Absent when no allowance applies.

Example:

38

periodStart
string

Start of the current period (ISO 8601). Absent when no allowance applies.

periodEnd
string

End of the current period (ISO 8601, exclusive); the allowance renews then. Absent when no allowance applies.