billing

GET `/v1/sla/periods`

Recent months for every monitored site, and what may be claimed.

Authentication

Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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/sla/periods \
  -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

One row per monitored site per calendar month, over the last six months. Only monitors attached to a site we host appear: we do not promise uptime for a URL we do not serve, and watching URLs we do not serve is the uptime product's whole purpose. ⛔⛔ verdict has three values and they must not be folded into a boolean — met, missed, and unadjudicable when our own coverage was too thin to decide. Reading unadjudicable as met is the convenient fold and it is the one that saves us money, so it is refused here (§2.44). uptime_percent is null when no check was made: zero checks is not zero uptime. Gated on billing.view.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already read, so an org…

Response

Name	Type	Required	What it is
`policy`	`SlaPolicy`	Yes	—
`periods`	`SlaPeriod[]`	Yes	—

Errors this endpoint can return

401 · 403