v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB
Usage

Retrieve your monthly usages

The endpoint allows you to retrieve your monthly usages of the API

get/usages

Query parameters

startTimestring date-time

Start time at which usages must be found

endTimestring date-time

End time at which usages must be found

Response

The monthly usages

allCallsinteger required
successCallsinteger required
clientErrorCallsinteger required
serverErrorCallsinteger required
consumedApiUnitsinteger required
periodicUsagesPeriodicUsages

Example response

{
  "allCalls": 15,
  "successCalls": 13,
  "clientErrorCalls": 1,
  "serverErrorCalls": 1,
  "consumedApiUnits": 25,
  "periodicUsages": {
    "2022-05": {
      "allCalls": 15,
      "successCalls": 13,
      "clientErrorCalls": 1,
      "serverErrorCalls": 1,
      "consumedApiUnits": 25
    }
  }
}