billing
GET /v1/sla/periods
Recent months for every monitored site, and what may be claimed.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/sla/periods \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | 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… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
policy | SlaPolicy | Да | — |
periods | SlaPeriod[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403