Авторизация и формат ответа

Адрес метода строится как https://tools.pixelplus.ru/projects/api/v1/<группа>/<метод>. Токен доступа передаётся GET-параметром token в общем списке параметров, проект — параметром project_id. Токен создаётся в настройках аккаунта; доступ проверяется по тем же правилам, что и в интерфейсе: свои проекты и проекты, к которым вам выдан доступ.

1uptime/get — история доступности

GET /projects/api/v1/uptime/get — возвращает массив интервалов за выбранный период. В каждом интервале: процент успешных проверок и признак блокировки бота. Интервалы идут подряд без пропусков, включая те, по которым проверок не было.

Значения параметра period

Поля элемента result

Ответ

{
  "status": "ok",
  "code": 1,
  "msg": "success",
  "result": [
    {
      "date": "2026-09-15 10:00",
      "percent": 100,
      "bot_blocked": false
    },
    {
      "date": "2026-09-15 11:00",
      "percent": 0,
      "bot_blocked": true
    },
    {
      "date": "2026-09-15 12:00",
      "percent": null,
      "bot_blocked": null
    }
  ]
}

2bot_blocked — блокировка бота

Сайт может отвечать по-разному браузеру и роботу: фильтр трафика или WAF пропускает посетителя и отдаёт ошибку боту. В такой ситуации percent равен нулю, хотя сайт открывается и работает. Поле bot_blocked отделяет этот случай от настоящего падения сайта.

Если bot_blocked равен true, владельцу сайта нужно добавить IP-адреса и User-Agent Пиксель Тулс в исключения фильтра. Актуальный список и инструкция: разблокировка ботов Пиксель Тулс. До этого момента аптайм по проекту будет нулевым, хотя сайт доступен для посетителей.

Коды ошибок

Ошибка приходит с HTTP-кодом 200, в теле — status: "error" и код в поле code.

Пример ответа при ошибке

{
  "status": "error",
  "code": 52,
  "msg": "wrong request data",
  "result": {
    "message": "Acceptable values of period: day, week, two_weeks, month, quarter"
  }
}

Примеры

cURL

curl "https://tools.pixelplus.ru/projects/api/v1/uptime/get?token={токен}&project_id=7002&period=week"

PHP

<?php

$url = 'https://tools.pixelplus.ru/projects/api/v1/uptime/get?' . http_build_query([
    'token'      => '{токен}',
    'project_id' => 7002,
    'period'     => 'week',
]);

$response = json_decode(file_get_contents($url), true);

if (($response['status'] ?? '') !== 'ok') {
    throw new RuntimeException($response['msg'] ?? 'unknown error');
}

foreach ($response['result'] as $row) {
    if ($row['bot_blocked'] === true) {
        echo "{$row['date']}: сайт блокирует бота\n";
    } elseif ($row['percent'] !== null) {
        echo "{$row['date']}: {$row['percent']}%\n";
    }
}

Python

import requests

r = requests.get(
    'https://tools.pixelplus.ru/projects/api/v1/uptime/get',
    params={'token': '{токен}', 'project_id': 7002, 'period': 'week'},
    timeout=30,
)
data = r.json()

if data['status'] != 'ok':
    raise RuntimeError(data['msg'])

for row in data['result']:
    if row['bot_blocked']:
        print(row['date'], '— сайт блокирует бота')
    elif row['percent'] is not None:
        print(row['date'], f"{row['percent']}%")

Ограничения и рекомендации

• Проверки идут только по проектам, где включена техпроверка «Общие показатели» и заполнено главное зеркало. Если проверок нет вообще, метод вернёт интервалы с percent: null.
• Каждый проект проверяется примерно раз в 21 минуту — около трёх проверок в час. Поэтому для period=day процент в часе считается по нескольким замерам и принимает значения вида 0, 33.33, 66.67 и 100.
• История хранится 90 дней, более старые записи удаляются. Это же ограничение задаёт максимальную глубину периода quarter.
• Поля date и percent не менялись при добавлении bot_blocked — интеграции, написанные до этого, продолжают работать без правок.
• Вызовы метода лимиты не расходуют. Лимиты списывает сам сбор аптайма — фиксированно около 2 057 лимитов за 30 дней на проект.