usage

Retrieve usage

Returns requests and credits used in the period, in total and by day, endpoint and API key.

get/usage

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/usage
  • Auth: HTTP bearer

Query parameters

daysinteger

Number of days to include, ending now, between 1 and 365. Defaults to 30.

Response

The usage summary.

object'usage_summary' required

The object's type. Always usage_summary.

organization_idstring required

The organization's id.

sincestring date-time required

The start of the period.

untilstring date-time required

The end of the period: the time of the request.

requestsinteger required

Requests made in the period.

credits_spentinteger required

Credits spent in the period.

free_requestsinteger required

Successful requests that cost no credits: free endpoints, repeat requests within a day, empty results and reads in Explorer.

credit_balanceinteger required

The current credit balance.

included_creditsinteger required

Credits included with the plan each billing period. 0 without a plan.

Example response

{
  "organization_id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "by_endpoint": [
    {
      "name": "/v1/parcel"
    }
  ],
  "by_key": [
    {
      "name": "/v1/parcel"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.