Skip to content
Overwatch API

Get one site's usage

GET
/v1/sites/{id}/usage
curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage \
  --header 'x-api-key: <x-api-key>'

One site’s usage rolled up per month (oldest → newest), plus the current billing period’s metered usage against the per-app allowances. Read from the billing ledger, so it stays accurate across configuration changes. Prices live on GET /v1/billing (managers); this is just consumption, so members and CMS keys can read it.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string format: uuid

The site’s UUID.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Monthly usage plus the current period’s allowance meters.

Media typeapplication/json
object
byMonth
required
Array<object>

One month of crawl usage.

object
billing_period
required

UTC billing period, YYYY-MM.

string
runs
required
integer
pages_crawled
required
integer
links_checked
required
integer
current
required
object
period
required

The current UTC billing period, YYYY-MM.

string
pagesCrawled
required

Pages crawled this period.

integer
pagesRendered
required

Pages rendered by the accessibility scan this period.

integer
monitors
required

Uptime monitors currently configured on the site.

integer
allowances
required

The per-site monthly allowances the meters run against.

object
pagesCrawled
required
integer
pagesRendered
required
integer
monitors
required
integer
Example
{
  "byMonth": [
    {
      "billing_period": "2026-06"
    }
  ]
}

401

Section titled “ 401 ”

Missing or invalid credentials.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
  "error": "invalid api key"
}

404

Section titled “ 404 ”

No site with that id is visible to the caller.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
  "error": "site not found"
}