TOtopograph
Discrepancy reports (Beta)

Get discrepancy report usage (Beta)

Changed on

Beta. Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.

Reports counted in the current period against your subscription allowance.

get/v2/discrepancy-reports/usage

Request

  • Base URL
    https://api.topograph.co
  • URL
    https://api.topograph.co/v2/discrepancy-reports/usage
  • Auth
    API key in header x-api-key

Headers

x-topograph-workspace-idstring

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

Response

Usage in the current period

limitnumber

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

usednumber required

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

remainingnumber

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

periodStartstring

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

periodEndstring

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

Example response

{
  "limit": 50,
  "used": 12,
  "remaining": 38
}

Changes