API – Видимость / Запросы

Описание API-методов v5 для работы с модулем Видимость

Для начала работы с API SEOWORK необходимо обратиться в поддержку по почте help@seowork.ru или в чате на сайте. Для вас будет создан API токен.

Получение запросов с метриками за выбранную дату

GET https://api.seowork.ru/semantics/api/v5/dashboard/query

Для получения используется GET-запрос со следующими параметрами:

Имя	Обязательный	Тип	Значение по умолчанию	Описание
`project_id`	Да	`integer`		id проекта
`token`	Да	`string`		Токен авторизации
`date`	Нет	`string`	Последняя дата апдейта	Дата в формате yyyy-mm-dd
`search_engine`	Нет	`string`	yandex - для проектов seowork.ru google - для проектов seowork.io	Поисковая система
`limit`	Нет	`integer`		Количество записей на странице
`offset`	Нет	`integer`		Пропуск записей для пагинации
`page`	Нет	`integer`		Страница

Для получения даты апдейта используйте отдельный API запрос.

Например:

https://api.seowork.ru/semantics/api/v5/dashboard/query?token=...&project_id=123&date=2019-12-20&search_engine=yandex

Формат ответа

Объект в формате json, в котором содержится список доступных проектов с перечислением их свойств:

Имя	Описание
`date`	Дата апдейта
`search_engine`	Поисковая система
`id`	id категории
`name`	Имя запроса
`document_id`	id страницы, к которой привязан запрос
`document`	url страницы в семантике, к которой привязан запрос
`real_document`	url страницы в выдаче по этому запросу
`rel_document`	Показатель совпадения урла в выдаче с урлом в семантике
`category_id`	id категории, в которой находится запрос
`category_name`	Имя категории, в которой находится запрос
`position`	Позиция в выдаче
`ws1`	Показатель частотности WS1
`ws2`	Показатель частотности WS2
`p_traf`	Потенциальный трафик

{
  "has_data": true,
  "data": {
    "items": [
      {
        "date": "2024-03-15",
        "search_engine": "yandex",
        "id": "1234321",
        "name": "запрос",
        "document_id": "812495",
        "document": "https://url.com/",
        "real_document": "https://other.url.com/",
        "rel_document": false,
        "category_id": "282307",
        "category_name": "стройматериалы",
        "position": 7,
        "ws1": 416,
        "ws2": 16
        "p_traf": 76
      },
      ...
    ],
    "count": 9,
    "total": 9,
    "limit": 100,
    "page": 1
  },
  "version": 1,
  "status": 200,
  "error": 0,
  "error_messages": [],
  "response_time": 0.0000000000000001,
  "server_timestamp": "2023-05-26 00:00:00",
  "server_unixtimestamp": 1685059200
}

👆 На этом пока всё