Содержание
API для общих данных
Список поисковых систем
Описание
Метод позволяет получить список доступных поисковых систем, которые можно добавить в проекты для отслеживания позиций, с возможными регионами.
Формат запроса
GET /system/search-enginesРезультат
В случае успеха сервер возвращает массив со списком доступных поисковых систем.
| Имя | Описание |
| id | Уникальный идентификатор поисковой системы |
| name | Название |
| region_id | ID региона |
| type | Тип поисковой системы |
Пример ответа
[
{
«id»: «200»,
«name»: «Google USA»,
«regionid»: «182»
},
{
«id»: «201»,
«name»: «Google Andorra»,
«regionid»: «4»
},
{
«id»: «202»,
«name»: «Google United Arab Emirates»,
«regionid»: «178»
},
…
]Список доступных регионов для Яндекса
Описание
Метод позволяет получить список доступных регионов для поисковой системы Яндекс.
Формат запроса
GET /system/yandex-regionsРезультат
В случае успеха сервер возвращает массив, содержащий список регионов для Яндекса, и их уникальные идентификаторы.
Пример ответа
{
«1»: «Москва и область»,
«2»: «Санкт-Петербург»,
«3»: «Центр»,
«4»: «Белгород»,
«5»: «Иваново»,
…
«122068»: «Амбролаури»,
«122069»: «Зугдиди»,
«122070»: «Ахалцихе»,
«123580»: «Теджен»
}Список доступных регионов для Google
Описание
Метод позволяет получить список доступных регионов для поисковой системы Google.
Формат запроса
GET /system/google-regionsРезультат
В случае успеха сервер возвращает массив, содержащий список регионов для Google.
[
{ «name»: «Kabul, Kabul, Afghanistan», «region_id»: 1 },
…]Список языков для Google
Описание
Метод позволяет получить полный список возможных языков для поисковой системы Google.
Формат запроса
GET /system/google-langsРезультат
В случае успеха сервер возвращает массив с полным списком кодов языков и их названиями для поисковой системы Google.
| Имя | Обязательный | Описание |
| lang_code | Да | Код языка |
| name | Да | Название языка |
Пример ответа
[
«de»:»Deutsch»,
«en»:»English»,
«es»:»español»
…
]Список регионов для получения частотности
Описание
Метод позволяет получить список всех регионов, по которым можно проверить частотность в онлайн-сервисе SE Ranking.
Параметры
Для этого метода нет параметров.
Формат запроса
GET /system/volume-regions
Результат
В случае успеха сервер возвращает массив со списком регионов.
| Имя | Обязательный | Описание |
| id | Да | Уникальный идентификатор региона |
| name | Нет | Название региона |
Пример ответа
[
{
«id»: «180»,
«name»: «United Kingdom»,
},
{
«id»: «182»,
«name»: «USA»,
},
…
]Получение частотности для ключевых слов
Описание
Метод позволяет получить частотность для указанного региона и списка ключевых слов.
Параметры
| Имя | Обязательный | Описание |
| region_id | Да | ID региона. Все регионы и их ID можно получить в методе /system/volume-regions |
| keyword | Да | Массив ключевых слов, для которых будет получена частотность. Кириллические ключевые слова в URL должны быть в url-encoded, т.е. «ключ» превратится в %D0%BA%D0%BB%D1%8E%D1%87 В списке может быть максимум 10 слов. |
| yandex_region_code | Нет | Код региона из wordstat (необязательный параметр, если указан – вернётся частотность из Яндекс Вордстат, если нет – из Google) |
Формат запроса
GET /system/volume?regionid=12&keyword[]=%D0%BA%D0%BB%D1%8E%D1%87Результат
В случае успеха сервер возвращает массив ключевых слов с частотностью.
| Имя | Обязательный | Описание |
| volume | Да | Частотность ключевого слова |
Пример
{
«key1»: «1000»,
«key2»: «10000»
…
«keyN»: «100000»
}Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Not enough params. region_id and keyword required |
| 400 | Incorrect region_id |
| 404 | No data |