Данные по позициям из модуля Отчеты - Позиции
Для начала работы с API SEOWORK необходимо обратиться в поддержку по почте help@seowork.ru или в чате на сайте. Для вас будет создан API токен для работы.
В системе SEOWORK должны быть добавлены и настроены проекты в разделе Отчеты — Позиции.
Для получения данных по позициям вам необходимо указать по какому проекту, каким запросам и каких поисковых систем нужно и пр.
- Последовательность получения необходимых данных описано ниже (Проекты → Запросы → Позиции)
- Так же ниже описано Добавление запросов, Удаление запросов
Проекты
GET-Запрос
https://seowork.ru/position/api/v1/projects?token={token}&page=1
По этому запросу получаем список доступных проектов с указанием id, хоста, региона, количества запросов, поисковой системы. На каждую страницу лимит в 100 записей, для просмотра следующей страницы необходимо в запросе указать соответствующее обозначение для параметра page
Здесь же можно посмотреть данные по лимитам и количеству записей
Запросы
GET-Запрос:
https://seowork.ru/position/api/v1/queries/{project_id}?token={token}&page=1
Отправляя запрос с указанием проекта (project_id) получаем информацию о количестве запросов (data.total) и самих запросах (id, name, cost). Аналогично как и в проектах есть лимит на отображение записей на странице, нужно менять номер страницы при обращении
Позиции
GET-Запрос:
https://seowork.ru/position/api/v1/positions/{project_id}?token={token}&page=1&query_id[]={query_id}&query_id[]={query_id}&date=2018-09-01
В обращении перечисляем для каких запросов (query_id, получили их в запросах) и за какую дату (date) нам необходимы позиции. В ответ получаем данные — позиция, документы в выдаче и статус
В итоге.
Процесс выглядит следующим образов:
Получаем id проекты → получаем id запросов → получаем данные по позициям запросов
Пример ответа
Добавление запросов
запрос:
curl -X POST -d '{"queries": [{"name": "q1", "cost": 0.15}, {"name": "q2"}]}'
'http://localhost/position/api/v1/queries/{project_id}?token={token}'
{"data":{"task_id":{task_id},"version":null,"status":200,"error":0,"error_messages":[]}
Удаление запросов
запрос:
curl -X DELETE -d '{"queries": [1, 2, 3]}'
'http://localhost/position/api/v1/queries/{project_id}?token={token}'
в случае успеха: {"data":{"task_id":{task_id}},"version":null,"status":200,"error":0,"error_messages":[]}