SEO Данные
API SEO Данные — API предназначено для получения Топ-100 поисковой выдачи (URL-адрес, сниппет, позиция сайта) по ключевым фразам без создания проекта в сервисе SE Ranking.
Стоимость использования эндпоинта «Добавление ключевого слова» составляет:
0.03 р. / $0.003
Добавление ключевого слова
Описание
Метод позволяет добавить ключевое слово в очередь для получения результатов поиска.
Параметры
| Имя | Обязательный | Описание |
| query | Да | Поисковый запрос или массив запросов (запрос максимум 255 символов, массив, максимум 1000 запросов) |
| engine_id | Да | Уникальный идентификатор поисковой системы. Получить полный список поисковых систем с уникальными идентификаторами можно в методе GET /system/search-engines (только type google) |
| region_name | Нет | Название региона для поиска (только для поисковой системы Google)
|
| region_id | Нет |
|
Формат запроса
POST /parsing/serp/tasks
{
"engine_id": 1,
"region_id": 140,
"query": "text"
or
"query": ["text", "text2"]
}
Результат
В случае успеха сервер возвращает уникальный идентификатор для каждого добавленного ключевого слова в очередь.
| Имя | Обязательный | Описание |
| task_id | Да | Уникальный идентификатор запроса |
Пример ответа
[{
"query": :"text",
"task_id": 123456
}]
Ошибки
| HTTP-код | Сообщение об ошибке |
| 403 | Empty balance |
| 400 | Invalid engine_id |
| 400 | Invalid region_id |
| 400 | Empty query |
| 400 | Query $query too long |
Проверка статуса и получение результата проверки
Описание
Метод позволяет получить результат по ключевому слову, ранее добавленному в очередь. Если снятие позиций по ключевому слову еще не завершено, метод вернет статус. Результаты хранятся 24 часа, затем они удаляются.
Параметры
| Имя | Обязательный | Описание |
| task_id | Да | Уникальный идентификатор запроса |
Формат запроса
GET /parsing/serp/tasks/{task_id}Результат
В случае успеха сервер возвращает статус ключевого слова.
Если запрос в очереди, возвращает статус: processing.
Пример ответа
{
"status": "processing"
}Если проверка завершена, сервер возвращает результаты проверки. В случае успеха сервер возвращает массив, содержащий результаты из ТОП 100 выдачи по ключевому слову.
| Имя | Обязательный | Описание |
| position | Да | Позиция страницы в ТОП 100 |
| url | Да | Ссылка страницы, которая ранжируется в ТОП 100 |
| title | Да | Заголовок страницы в ТОП 100 |
| snippet | Да | Сниппет, описание страницы в ТОП 100 |
| cache_url | Нет | Ссылка на кэшированную копию страницы, которая ранжируется в ТОП 100 |
Пример ответа
{
"results": [
{
"position": "1",
"url": "https://www.pizzahut.com/",
"title": "Pizza Hut: Pizza Delivery",
"snippet": "Order pizza online for fast delivery or carryout from a store near you. View our full menu, see nutritional information, find store locations, and more.",
"cache_url": "https://webcache.googleusercontent.com/search?q=cache:oiTvlHsuOeEJ:https://www.pizzahut.com/+&cd=4&hl=en&ct=clnk&gl=us"
},
...
"position": "99",
"url": "https://techcrunch.com/2018/08/20/google-doctor-fork/",
"title": "Google created a fake pizza brand to test out creative strategies for ...",
"snippet": "Aug 20, 2018 - Google's Unskippable Labs team has been testing ad effectiveness in a compelling new way: It created a fake pizza brand called Doctor Fork, ...",
"cache_url": "https://webcache.googleusercontent.com/search?q=cache:wi5sKCy0ResJ:https://techcrunch.com/2018/08/20/google-doctor-fork/+&cd=120&hl=en&ct=clnk&gl=us"
}
]
}Ошибки
| HTTР-код | Сообщение об ошибке |
| 404 | Task not found |
Список всех запросов пользователя
Описание
Метод позволяет получить список всех запросов пользователя, которые были добавлены в очередь за последние 24 часа.
Формат запроса
GET /parsing/serp/tasksРезультат
В случае успеха сервер возвращает массив, который содержит список ключевых слов, добавленных в очередь, и их статус.
| Имя | Описание |
| id | Уникальный идентификатор ключевого слова |
| query | Ключевое слово |
| region_name | Название региона для поиска (только для поисковой системы Google) |
| engine_id | Уникальный идентификатор поисковой системы. Получить полный список поисковых систем с уникальными идентификаторами можно в методе /system/search-engines.
|
| |
| added | Дата добавления ключевого слова в очередь |
| is_completed | Статус проверки ключевого слова (1 – проверено, 0 – нет) |
Пример ответа
{
"tasks": [
{
"id": "18638740",
"query": "book",
"region_name": null,
"engine_id": "411",
"region_id": "213",
"added": "2018-08-28 10:25:29",
"is_completed": "0"
},
...
{
"id": "18639398",
"query": "pizza",
"region_name": "New York",
"engine_id": "200",
"region_id": "0",
"added": "2018-08-28 12:25:52",
"is_completed": "1"
}
]
}