hosting
GET /v1/sites/{siteId}/usage
Get one site's metered visits for the current billing period.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/usage \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
This site's billable page views so far this billing period, alongside the organisation-wide allowance they count against. RLS-scoped to a site the caller can view (`sites.view`); an out-of-scope or unknown id is a `404`, exactly like `getSite`. **A visit is a human page view with bots excluded** (owner ruling 2026-08-11). Crawlers, automated agents, assets, redirects and error responses are all excluded, and `excludedPageViews` reports how many were — the rule is published so a customer can check it rather than take it on trust. **The organisation's totals are returned with the site's own** because a site figure cannot be read without its denominator: 40,000 views is unremarkable on Agency Growth and a chargeable overage on Starter. The allowance is granted to the plan, not to the site, and is shared across every site that plan pays for.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
period_start | string | Yes | — |
period_end | string | Yes | — |
page_views | integer | Yes | This site's billable human page views this period. |
excluded_page_views | integer | Yes | This site's page views excluded as automated. |
org_page_views | integer | Yes | Billable page views across every site on the plan. |
org_allowance | integer | Yes | The plan's allowance for this period. `-1` means unlimited. |
org_unlimited | boolean | Yes | — |
org_over_limit | boolean | Yes | Whether the plan's allowance is exceeded. The site keeps serving either way. |
Errors this endpoint can return
401 · 403 · 404 · 429