Документация API

Узнайте, как подключить и использовать наш API.

Получить свой API-ключ

Базовый URL

Аутентификация

Все конечные точки API требуют API-ключ, переданный методом аутентификации Bearer.

Authorization: Bearer {api_key}

Пример

curl --request GET \
--url 'https://analytics.readl.ru/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Ошибки

API использует стандартные коды HTTP для обозначения успешного или неуспешного выполнения запроса.

Пример

{
    "errors": [
        {
            "title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}

Коды состояния

200 Запрос выполнен успешно

400 Некорректный запрос — обязательные параметры отсутствуют или неверны

401 Нет доступа — API-ключ отсутствует или неверен

404 Запрошенный ресурс не найден

429 Слишком много запросов — превышен лимит

500 Внутренняя ошибка сервера — проблема на нашей стороне

Все результаты API используют часовой пояс UTC, если не указано иное.

Пользователь

Сайты

Просмотры страниц

Облегчённое отслеживание

Просмотры страниц

Расширенное отслеживание

Сеансы

Расширенное отслеживание

Дочерние события

Расширенное отслеживание

Клики по внешним ссылкам