billing

GET `/v1/sla/periods`

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/sla/periods \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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`.

Parameter

Name	Typ	Erforderlich	Was es ist
`org_id (query)`	`string`	Nein	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 out…

Antwort

Name	Typ	Erforderlich	Was es ist
`policy`	`SlaPolicy`	Ja	—
`periods`	`SlaPeriod[]`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403