Your API usage

GET /usage

Requires the businesses scope.

Your key's own request rollups per endpoint: requests and error counts over the window. Days are Asia/Jerusalem calendar days.

Query parameters

Name	Type		Description
`days`	integer		Window in days (default 30, max 365).

Response

200: { "ok": true, … }

Field	Type
`ok`	boolean	required
`days`	integer	required
`usage`	array of object	required

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

On this page

Query parameters Response

GET /usage

curl -X GET "$BASE/usage?days=" \
  -H "X-Api-Key: $KEY"

const res = await fetch(`${BASE}/usage`, {
  method: 'GET',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)

import requests
res = requests.get(
    f"{BASE}/usage",
    headers={"X-Api-Key": KEY},
)
data = res.json()

Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.

Manage your businesses, keys and webhooks in the BillOS Console.