SerpWatch
Меню

API: выгрузка данных в свои системы

Настроите автоматическую выгрузку позиций, сводки и аудита в свою CRM, BI или таблицы.

API — способ, которым программы обмениваются данными без участия человека. Через API SerpWatch ваша система (CRM, BI‑дашборд, Google Таблица со скриптом) сама забирает позиции и другие данные. API бесплатен на любом тарифе.

Создать токен

Токен — секретный ключ, по которому SerpWatch понимает, что запрос пришёл от вас.

  1. В верхнем меню нажмите API.
  2. Впишите понятное название, например «Отчёты агентства», и нажмите Создать токен.
  3. Появится блок «Новый токен — скопируйте сейчас». Скопируйте токен и сохраните в надёжном месте.
    Список токенов и форма создания: название (1) и кнопка «Создать токен» (2)
    Список токенов и форма создания: название (1) и кнопка «Создать токен» (2)

В таблице видно название каждого токена, его начало, дату создания и время последнего использования. Можно завести до 10 токенов — например, отдельный для каждой системы.

Как отправлять запросы

Адрес API — https://<адрес сервиса>/api/v1/…, ответ приходит в формате JSON. Токен передаётся в заголовке Authorization:

bash
curl -H "Authorization: Bearer sw_ваш_токен" https://serpwatch.ru/api/v1/projects

Полный список методов — на странице документации API.

Страница документации API
Страница документации API

Что можно получить

  • GET /api/v1/projects — ваши проекты и проекты, куда вас пригласили: id, название, домен, число запросов и регионы (id, код региона lr, название, устройство).
  • GET /api/v1/projects/{id}/keywords — запросы: группа, метки, целевой URL, частота.
  • POST /api/v1/projects/{id}/keywords — добавить запросы.
  • GET /api/v1/projects/{id}/positions — позиции по дням.
  • GET /api/v1/projects/{id}/summary — сводка: видимость, ТОП‑3/10/30, средняя и медиана.
  • GET /api/v1/projects/{id}/snapshots?keyword_id=… — снимок выдачи по запросу: место, URL, домен, заголовок и описание.
  • GET /api/v1/projects/{id}/audit — последний аудит: здоровье сайта и список проблем.

Позиции за период

Параметры: region_id (по умолчанию — первый регион проекта), date_from и date_to в формате ГГГГ-ММ-ДД (по умолчанию — последние 30 дней, не больше года за раз), keyword_id — один запрос.

bash
curl -H "Authorization: Bearer sw_ваш_токен" \
  "https://serpwatch.ru/api/v1/projects/1/positions?date_from=2026-09-01&date_to=2026-09-30"

Ответ — список строк:

json
[
  {"keyword_id": 15, "date": "2026-09-30", "source": "webmaster", "position": 4.2,
   "url": "https://site.ru/uslugi/", "impressions": 120, "clicks": 9}
]

source — откуда позиция: webmaster (Вебмастер) или serp (снимок выдачи).

Добавить запросы

bash
curl -X POST -H "Authorization: Bearer sw_ваш_токен" -H "Content-Type: application/json" \
  -d '{"keywords": ["ремонт акпп", "замена масла"], "group": "Услуги"}' \
  https://serpwatch.ru/api/v1/projects/1/keywords

Ответ: {"added": 2}. Повторы пропускаются, группа создаётся, если её ещё нет. Действует лимит запросов тарифа. С гостевым доступом «Просмотр» добавлять нельзя.

Ограничения и ошибки

  • Не больше 120 запросов в минуту на один токен.
  • Ошибка приходит в виде {"error": "…"} с кодом 4xx: 401 — нет токена или он неверный, 404 — проект не найден, 429 — превышен лимит в минуту.

Отозвать токен

На странице API нажмите Отозвать напротив токена. Системы, которые им пользовались, сразу потеряют доступ.

Что дальше

Термины по темеHTTPS
Не нашли ответ?Напишите нам — ответим и допишем статью, чтобы следующему было понятнее.
Связаться с нами