Начало работы
Авторизация
Для использования API Rush Analytics необходимо получить API-ключ, который можно найти в аккаунте пользователя Rush Analytics. Используйте его при всех запросах к API.
Если метод API вызван без API-ключа или в запросе передан недействительный API-ключ, то сервер возвращает ошибку “Invalid API key”.
Получение API-ключа
Чтобы начать пользоваться API:
- Войдите в ваш аккаунт;
- Перейдите в раздел меню -> API;
- Нажмите кнопку «Получить API-ключ».
Обратите внимание, что API поддерживается только на тарифах Pro и выше. На тарифе Lite, Start нет доступа к API.
Формат возврата
Результаты задачи доступны в формате Json и файлах Excel.
Лимиты и ограничения
Для обеспечения бесперебойной работы API для всех клиентов, мы ограничиваем скорость отправки запросов. Обращение к любым методам API можно делать не чаще 1-го раза в секунду.
Если клиентское приложение сделает больше 1-го запроса в секунду, то наш сервер вернет ошибку, если скорость не будет снижена — ваш ip временно будет заблокирован.
На разных тарифных планах доступно разное количество одновременных API-потоков.
- План Pro – 1 поток
- Pro+ — 10 потоков
- Team – 20 потоков
- Business – 30 потоков
- Business + — 50 потоков
- Corp – 100 потоков
API-поток дает возможность запустить 1 задачу, проверить статус проекта или получить результаты. Пока запрос не будет завершен второй запрос к API не получится сделать. Пример: если Вы запустили 1 задачу по сбору данных – запустить другую задачу или проверить ее статус вы сможете только после того, как запущенная задача будет готова. Пока она будет в процессе сбора данных нельзя создать новую задачу, проверить статус или получить результаты по другой задаче.
Параметры запроса
Протестировать API можно: https://app.rush-analytics.ru/apiv2/doc/
Список языков — https://app.rush-analytics.ru/apiLanguages.php
Список ID регионов в Google — https://app.rush-analytics.ru/apiRegionsGoogle.php
Список ID регионов в Яндекс — https://app.rush-analytics.ru/apiRegionsYandex.php
Основные сведения
Документация к API находится на https://app.rush-analytics.ru/apiv2/doc/
С практической точки зрения — API передает ваши данные в Rush Analytics для создания задачи в системе, которая встает в очередь на парсинг. Вы проверяете своим приложением статус задачи, и, как только она будет готова — получаете результат.
Формат возврата
Результаты задачи доступны в формате Json и файлах Excel.
Цены на использование API:
Все цены идентичны обычному созданию задач в Rush Analytics — цены доступны по ссылке
Проверка позиции
Этот метод позволяет получить список позиций и релевантных URL по ключевым словам по нескольким поисковым системам, а также URL лидеров тематики и их позиции.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш API ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| url | string | url или домен сайта для которого проверяются позиции | https://www.rush-analytics.ru/ |
| competitors | string | домен сайта конкурента. Можно ввести до 10 доменов | https://site24.com |
| dataCollectionFrequency | int | Частота сбора позиций: 0 – ежедневно, 1 – еженедельно, 2 – в ручном режиме, 3 – по Yandex апдейтам, 4 — по дням недели. | 0, 1, 2 и тд. |
| days | string | Используется при выборе сбора данных по конкретным дням. Обозначение дней: 0,1,2,3,4,5,6. 0 — Понедельник, 1 — Вторник и т.д. Если нужно указать несколько дней, то разделяем их запятой. | 0, 1, 2 и тд. |
| hour | int | Время запуска сбора данных. Формат: 0 — 23, где 0 — 0:00; 1 AM — 01:00. | 10 |
| yandexRegions | Регион поисковой системы Яндекс | ||
| googleRegions | Регион поисковой системы Google | ||
| type | string | Доменная зона | .com |
| Id | int | Id региона поисковой системы. Список Яндекс регионов — https://app.rush-analytics.ru/apiRegionsYandex.php Список Google регионов — https://app.rush-analytics.ru/apiRegionsGoogle.php | 213 |
| lang | string | Язык, на котором будет идти сбор данных — https://app.rush-analytics.ru/apiLanguages.php | ru |
| device | int | Устройство, по выдаче которого будут собираться данные: 0 — Декстоп 1 — Мобаил | 0 |
| keywords | string | Ключевые слова | семантическое ядро |
| target url | string | Целевой URL | https://www.rush-analytics.ru/ |
| group | string | Название группы ключевых слов | семантика |
Пример запроса
{
"apikey": "1ae...af4b",
"name":"google reg",
"url":"https://mosvetcenter.ru/",
"competitors":[
"https://mosvetcenter24.ru"
],
"dataCollectionFrequency":{
"frequency":0
},
"yandexRegions":[
{
"type":".ru",
"id":213,
"lang":"ru",
"device":0
}
],
"googleRegions":[
{
"type":".de",
"id":1003854,
"lang":"de",
"device":0
},
{
"type":".ae",
"id":1000010,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000011,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000012,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000013,
"lang":"en",
"device":1
}
],
"keywords":[
{
"keyword":"усыпление собак",
"targeturl":"https://mosvetcenter.ru/",
"group":"усыпление"
}
]
}Проверка статуса
GET /status/
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Type id | int | Id проверки позиций | 3 |
| Project id | int | Id задачи | 330098 |
Получение результата
GET /results/
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 330098 |
| page | int | Номер страницы с результатами: 1 — первые 1000 результатов. 2 — результаты от 1001-2000 и т.д | 1 |
| periodStart | String($date) | Получить результаты, начиная с даты | 2021-09-13 |
| periodEnd | String($date) | Получить результаты, заканчивая датой | 2021-12-14 |
| competitors | string | Домен конкурента. Используется только для получения результатов по позициям конкурентов | site.com |
Пример запроса для получения результатов из вкладки динамика позиций
https://app.rush-analytics.ru/apiv2/result/ranktracker/dynamic/24ХХ3/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998e8...ХХХ
Пример ответа
[{
"keywords": [
{
"keyword": "системы lms",
"wordstat": 521,
"wordstat ''": 113,
"wordstat '!'": 53,
"group": "lms системы",
"targeturl": "https://www.unicraft.org/blog/5613/sistema-upravleniya-obucheniem-lms/",
"relevanturl": "https://www.unicraft.org/blog/5613/sistema-upravleniya-obucheniem-lms/",
"positions": [
{
"date": "08.12.2021",
"position": "16"
},
{
"date": "14.12.2021",
"position": "24",
"diff": -8
}
]Пример запроса для получения результатов из вкладки видимость
https://app.rush-analytics.ru/apiv2/result/ranktracker/visibility/2ХХХ3/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...ХХХПример ответа
{
"visibility": [
{
"traffic": 1358,
"group": "Суммарная видимость",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 57.1
},
{
"date": "27.11.2021",
"visibility": 48.27,
"diff": -8.83
}
]
},
{
"traffic": 357,
"group": "group1",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 60.33
},
{
"date": "27.11.2021",
"visibility": 51.66,
"diff": -8.67
}
]
},
{
"traffic": 0,
"group": "group2",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 85
},
{
"date": "27.11.2021",
"visibility": 10,
"diff": -75
}
]
}
]
}Пример запроса для получения списка конкурентов (необходимо для получения позиций по конкурентам)
https://app.rush-analytics.ru/apiv2/result/ranktracker/competitors/22ХХХ/1?apikey=acc998e8...ХХХПример ответа
["assistentus.ru",
"planfact.io",
"ru.wikipedia.org",
"netology.ru",
"kom-dir.ru",
"vc.ru",
"gd.ru",
"hh.ru",
"hr-director.ru",
"timeweb.com"
]Пример запроса для получения списка регионов проекта
https://app.rush-analytics.ru/apiv2/result/ranktracker/regions/23ХХХ/1?apikey=acc998...ХХХПример ответа
[
{
"searchEngine": [
{
"id": 33091,
"name": "Яндекс.ru - Москва(213)",
"device": "desktop"
},
{
"id": 33094,
"name": "Google.ae - Дубай (Город)",
"device": "mobile"
}
]
}
]Пример запроса для получения истории позиций
https://app.rush-analytics.ru/apiv2/result/ranktracker/positions_history/24ХХХ/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...ХХХПример ответа
[
{
"keyword": "системы lms",
"positions_history": [
{
"date": "14.12.2021",
"position": "24 (-8)"
},
{
"date": "08.12.2021",
"position": "16"
}
]Пример запроса для получения истории URL
https://app.rush-analytics.ru/apiv2/result/ranktracker/urls_history/24XXX/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...XXXПример ответа
[
{
"keyword": "системы lms",
"target_url": "/blog/5613/sistema-upravleniya-obucheniem-lms/",
"urls_history": [
{
"date": "14.12.2021",
"url": "https://www.unicraft.org/blog/5613/sistema-upravleniya-obucheniem-lms/"
},
{
"date": "08.12.2021",
"url": "https://www.unicraft.org/blog/5613/sistema-upravleniya-obucheniem-lms/"
}
]Пример запроса для получения истории сниппетов
https://app.rush-analytics.ru/apiv2/result/ranktracker/snippets_history/24XXX/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...XXXПример ответа
[
{
"keyword": "системы lms",
"position": "24",
"snippets_history": [
{
"date": "14.12.2021",
"snippet": "LMS системы для бизнеса: ключевые принципы работы<br />LMS (Learning Management System) — система управления обучением"
},
{
"date": "08.12.2021",
"snippet": "LMS системы для бизнеса: ключевые принципы работы<br />LMS (Learning Management System) — Она позволяет разрабатывать учебные материалы и предоставлять к ним совместный доступ в режиме реального времени."
}
]Пример запроса для получения видимости по конкурентам
https://app.rush-analytics.ru/apiv2/result/ranktracker/competitors_visibility/244XXX/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...XXXПример ответа
[
{
"competitor": "unicraft.org",
"visibilities": [
{
"date": "08.12.2021",
"visibility": "9.27%"
},
{
"date": "14.12.2021",
"visibility": "7.85% (-1.42%)"
}
]
},
{
"competitor": "planfact.io",
"visibilities": [
{
"date": "08.12.2021",
"visibility": "31.04%"
},
{
"date": "14.12.2021",
"visibility": "29.29% (-1.75%)"
}
]Пример запроса для получения лидеров тематики
https://app.rush-analytics.ru/apiv2/result/ranktracker/competitors_leaders/24ХХХ/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...ХХХПример ответа
[
{
"competitor": "unicraft.org",
"top10_info": [
{
"date": "14.12.2021",
"top10_keywords": 14
}
]
},
{
"competitor": "planfact.io",
"top10_info": [
{
"date": "14.12.2021",
"top10_keywords": 52
}
]
},
{
"competitor": "netology.ru",
"top10_info": [
{
"date": "14.12.2021",
"top10_keywords": 51
}
]Пример запроса для получения позиций конкурентов
https://app.rush-analytics.ru/apiv2/result/ranktracker/competitors_positions/24ХХХ/1?periodStart=2021-09-13&periodEnd=2021-11-28&competitor=mossite24.ru&apikey=acc998e...ХХХПример ответа
[
{
"keyword": "системы lms",
"wordstat": 521,
"group": "lms системы",
"positions": [
{
"date": "08.12.2021",
"position": "> 100"
},
{
"date": "14.12.2021",
"position": "> 100"
}
]
},
{
"keyword": "lms система",
"wordstat": 521,
"group": "lms системы",
"positions": [
{
"date": "08.12.2021",
"position": "> 100"
},
{
"date": "14.12.2021",
"position": "> 100"
}
]Пример запроса для получения сравнения позиций по регионам
https://app.rush-analytics.ru/apiv2/result/ranktracker/compare_regions/24XXX/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...XXXПример ответа
[
"keyword": "купить компьютер в москве",
"regions_positions": [
{
"region": "Яндекс.ru - Москва(213)",
"device": "desktop",
"lang": "RU",
"id": 328368,
"date": "14.12.2021",
"position": "1"
},
{
"region": "Google.ru - Москва (Город)",
"device": "desktop",
"lang": "RU",
"id": 328369,
"date": "14.12.2021",
"position": "4"
},
{
"region": "Яндекс.ru - Волгоград(38)",
"device": "desktop",
"lang": "RU",
"id": 328984,
"date": "14.12.2021",
"position": "1"
},
{
"region": "Яндекс.ru - Саратов(194)",
"device": "desktop",
"lang": "RU",
"id": 328985,
"date": "14.12.2021",
"position": "3"
},
{
"region": "Яндекс.ru - Сибирь(59)",
"device": "desktop",
"lang": "RU",
"id": 328986,
"date": "14.12.2021",
"position": "1"
},
{
"region": "Яндекс.ru - Таиланд(995)",
"device": "desktop",
"lang": "RU",
"id": 328987,
"date": "14.12.2021",
"position": "1"
},
{
"region": "Яндекс.ru - Туапсе(1058)",
"device": "desktop",
"lang": "RU",
"id": 328988,
"date": "14.12.2021",
"position": "3"
}
]Разовая проверка позиций
Этот метод позволяет получить список позиции, релевантных URL по ключевым словам, а также URL лидеров тематики.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| url | string | url или домен сайта, для которого проверяются позиции | https://www.rush-analytics.ru/ |
| yandexRegions | Регион поисковой системы Яндекс | ||
| googleRegions | Регион поисковой системы Google | ||
| type | string | Доменная зона | .com |
| Id | int | Id региона поисковой системы. Список Яндекс регионов — https://app.rush-analytics.ru/apiRegionsYandex.php Список Google регионов — https://app.rush-analytics.ru/apiRegionsGoogle.php | 213 |
| lang | string | Язык, на котором будет идти сбор данных — https://app.rush-analytics.ru/apiLanguages.php | ru |
| device | int | Устройство, по выдаче которого будут собираться данные: 0 — Декстоп 1 — Мобаил | 0 |
| keywords | string | Ключевые слова | семантическое ядро |
Получение результата
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| Type id | int | Id разовой проверки позиций | 1 |
| Project id | int | Id задачи | 324234 |
| apikey | string | Ваш api ключ | n/a |
Пример запроса
{
"apikey": "acc99ХХХ…dcef",
"name": "название проекта",
"url": "rush-analytics.ru",
"yandexRegions": [
{
"type": ".ru",
"id": 213,
"lang": "ru",
"device": 0
}
],
"googleRegions": [
{
"type": ".ru",
"id": 1011969,
"lang": "ru",
"device": 0
}
],
"keywords": [
"семантическое ядро"
]
}Пример ответа
[
{
"regionid": "213",
"searchEngine": "Yandex",
"device": "0",
"keywords": [
{
"keyword": "семантическое ядро",
"position": "19",
"url": "https://www.rush-analytics.ru/blog/polnyy-gayd-po-semanticheskomu-yadru-ot-sbora-klyuchevyh-slov-do-klasterizacii"
}
],
"leadersOfTheme": [
{
"domain": "ru.wikipedia.org",
"visibility": 1
},
{
"domain": "TexTerra.ru",
"visibility": 1
},
}
]
},
{
"regionid": "1011969",
"searchEngine": "Google",
"device": "0",
"keywords": [
{
"keyword": "семантическое ядро",
"position": "10",
"url": "https://www.rush-analytics.ru/"
}
],
"leadersOfTheme": [
{
"domain": "ru.wikipedia.org",
"visibility": 1
},
{
"domain": "texterra.ru",
"visibility": 1
},
{
"domain": "netpeak.net",
"visibility": 1
}
]
}
]Сбор ТОП 10 URL
Этот метод позволяет получить ТОП 10-100 URL по ключевым словам, а также URL лидеров тематики.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| depth | int | Глубина парсинга (10,20, 30, 40, 50, 60, 70, 80, 100) | 10 |
| searchEngine | string | Поисковая система (Yandex или Google) | Yandex |
| type | string | Доменная зона | .com |
| Id | int | Id региона поисковой системы. Список Яндекс регионов — https://app.rush-analytics.ru/apiRegionsYandex.php Список Google регионов — https://app.rush-analytics.ru/apiRegionsGoogle.php | 213 |
| lang | string | Язык на котором будет идти сбор данных — https://app.rush-analytics.ru/apiLanguages.php | ru |
| keywords | string | Ключевые слова | семантическое ядро |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Получение результатов
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Пример запроса
{
"apikey": "b9eeХХХ….251",
"name": "название проекта",
"depth": 10,
"searchEngine": "Yandex",
"region": {
"type": ".ru",
"id": 213,
"lang": "ru"
},
"keywords": [
"семантика"
]
}Пример ответа
{
"regionid": 213,
"keywords": [
{
"keyword": "string",
"urls": [
"https://ru.wikipedia.org/wiki/String_(C%2B%2B)",
"https://docs.microsoft.com/ru-ru/dotnet/api/system.string?view=netcore-3.1",
"https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/String",
"https://ravesli.com/urok-57-vvedenie-v-std-string/",
"https://javarush.ru/groups/posts/1411-klass-string",
"https://habr.com/ru/post/165597/",
"https://en.wikipedia.org/wiki/String_(computer_science)",
],
"titles": []
}
],
"leadingDomains": {
"ru.wikipedia.org": 1,
"docs.microsoft.com": 1,
"developer.mozilla.org": 1,
"ravesli.com": 1,
"javarush.ru": 1,
"javascript.ru": 1
}
}Проверка индексации страниц сайта
Этот метод позволяет проверить индексацию страниц сайта в поисковых системах Яндекс и Google.
Параметры запроса
| Назывное | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| urls | string | URLs для проверки. | https://www.rush-analytics.ru/pricing-plans |
| searchEngines | string | Поисковая система (Yandex, Google) | «»Yandex», «Google» |
| googleCountry | string | Доменная зона Google региона | .com |
| googleLanguage | string | Язык Google региона | en |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Type id | int | Id для индексации (5) | 1 |
| Project id | int | Id задачи | 324234 |
Получение результатов
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Пример запроса
{
"apikey": "b9eXXX….251",
"name": "stri5ng",
"urls": [
"https://www.rush-analytics.ru/pricing-plans"
],
"searchEngines": [
"Yandex",
"Google"
],
"googleCountry": ".ru",
"googleLanguage": "ru"
}Пример ответа
1 — URL проиндексирован поисковой системой
0 — URL не проиндексирован поисковой системой
[
{
"url": "https://www.rush-analytics.ru/pricing-plans",
"yandexIndexed": "1",
"googleIndexed": "1"
}
]Сбор поисковых подсказок
Этот метод позволяет собрать поисковые подсказки с Яндекс, Google и Youtube.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш API ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| yandexRegions | int | Список Яндекс регионов — https://app.rush-analytics.ru/apiRegionsYandex.php | |
| googleRegions | int | Список Google регионов — https://app.rush-analytics.ru/apiRegionsGoogle.php | |
| country | string | Доменная зона Google, Youtube региона | .com |
| language | string | Язык Google, Youtube региона — https://app.rush-analytics.ru/apiLanguages.php | en |
| youtubeRegion | Добавление региона Youtube | ||
| depth | int | Глубина сбора данных (1, 2, 3). Рекомендуем выбирать 1 | 1 |
| keywords | string | Ключевые слова | семантическое ядро |
| stopwords | string | Стоп слова – удаляют ненужные найденные ключевые слова | бесплатно |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Type id | int | Id для поисковых подсказок (7) | 7 |
| Project id | int | Id задачи | 324234 |
Получение результатов
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Пример запроса
{
"apikey": "b9eХХХ….5251",
"name": "strin6g",
"yandexRegionId": 213,
"googleRegion": {
"country": ".ru",
"language": "ru"
},
"youtubeRegion": {
"country": ".ru",
"language": "ru"
},
"depth": 1,
"keywords": [
"семантическое ядро"
],
"stopwords": [
"бесплатно"
]
}Пример ответа
{
"семантическое ядро": [
"семантическое ядро это простыми словами",
"семантическое ядро интернет магазина инструкция",
"семантическое ядро интернет магазина",
"семантическое ядро и ключевые слова разница",
"семантическое ядро сайта пример",
"семантическое ядро заказать",
"семантическое ядро заработок"
]
}WORDSTAT
Этот метод позволяет собрать ключевые слова и частотность из Яндекс Wordstat.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| regionid | int | Id региона поисковой системы Яндекс. Список ID — https://app.rush-analytics.ru/apiRegionsYandex.php | 213 |
| projecttype | string | Что будем собирать: ключевые слова или частотность ( Keywords /SearchVolume) | Keywords |
| pages | int | Парсить страницы левой колонки Wordstat (1-10/40) Данный параметр указывается только при сборе ключевых слов. | 1 |
| normal | string | Общая частотность. Указывается только для задач по сбору частотности. | true |
| parenthesis | string | Частичное вхождение. Частотность типа “слово”. Указывается только для задач по сбору частотности. | true |
| exclamation | string | Частотности типа “!точное !вхождение”. Указывается только для задач по сбору частотности. | true |
| wordorder | string | Частотность с учетом порядка слов. Используется вместе с параметрами exclamation, parenthesis, normal. Указывается только для задач по сбору частотности с учетом порядка ключевых слов. | true |
| minimumwordstat | int | Фильтрация, удаляющая с результатов запросы с частотностью: равно и ниже указанного уровня. (можно не использовать) | 0 |
| keywords | string | Ключевые слова | семантическое ядро |
| stopwords | string | Стоп слова – удаляют не нужные найденные ключевые слова | Бесплатно |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Type id | int | Id для Wordstat (4) | 4 |
| Project id | int | Id задачи | 324234 |
Получение результатов
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Пример запроса
{
"apikey": "acc99XXX…347dcef",
"name": "название проекта",
"regionid": 213,
"projecttype": "Keywords",
"pages": 10,
"keywords": [
"авто"
],
"stopwords": [
"string"
]
}Пример ответа
{
"wordstatKeywordResult": [{
"keyword": "авто",
"collectedKeywords": [
{
"keyword": "авто",
"displays": 3113172
},
{
"keyword": "авто ру",
"displays": 560883
}
]
}
],
"regionid": 213
}Adwords
Этот метод позволяет собрать частотность ключевых слов из Google Keyword Planner.
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| googleRegion | Поисковая система Google | ||
| country | string | Доменная зона в Google | .com |
| region | int | Id региона Google. Список ID — https://app.rush-analytics.ru/apiRegionsGoogle.php | 2756 |
| language | string | Язык на котором будет идти сбор данных — https://app.rush-analytics.ru/apiLanguages.php | en |
| keywords | string | Ключевые слова | семантическое ядро |
| stopwords | string | Стоп слова – удаляют ненужные найденные ключевые слова | бесплатно |
Проверка статуса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Type id | int | Id для Аdwords (15) | 15 |
| Project id | int | Id задачи | 324234 |
Получение результатов
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| Project id | int | Id задачи | 324234 |
Пример запроса
{
"apikey": "acc99ХХХ…47dcef",
"name": "название проекта",
"googleRegion": {
"country": ".de",
"region": 9068242,
"language": "de"
},
"keywords": [
"auto"
],
"stopwords": [
"string"
]
}Пример ответа
{
"adWordsKeywordResult": [
{
"keyword": "частотность запросов онлайн сервис",
"count": 120
}
]
}Получение списка id созданных задач в конкретном инструменте
Параметры запроса
| Название | Формат | Описание | Пример |
|---|---|---|---|
| apikey | string | Ваш api ключ | n/a |
| name | string | Название задачи | Проверка позиций для сайта «Х» |
| Type | int | Типы задач: 1 – проверка позиций, 2 – ТОП 10, 5 – Индексация, 7 – Сбор подсказок, 4 – Wordstat, 15 — Adwords. |
Пример запроса
https://app.rush-analytics.ru/apiv2/projectids?apikey=acc...XXX7dcef&projecttype=2Пример ответа
{
"1": [
{
"id": "182713",
"name": "тест мобилка апи",
"created": "2018-06-04 16:41:01+00",
"keywordcount": "1"
},
{
"id": "183096",
"name": "name",
"created": "2018-06-07 09:09:45+00",
"keywordcount": "1"
{
"id": "734520",
"name": "название проекта",
"created": "2021-08-10 06:54:11+00",
"keywordcount": "1"
}
]
}Проверка баланса лимитов
Этот модуль позволяет проверить остаток лимитов на балансе тарифного плана.
Для этого вам необходимо добавить ваш apikey к запросу:
https://app.rush-analytics.ru/apiv2/balance?apikey=b9ХХХ...5251Ошибки
Все методы API могут возвращать следующие коды ошибок
| Ошибка | Код | Описание | Решение |
|---|---|---|---|
| Error: Forbidden | 403 | No more free API threads | Не осталось свободных потоков. Перейдите на тариф с большим количеством потоков или подождите. |
| Bad Request | 400 | Unknown project type | Часть данных, необходимых для создания задачи, отсутствует в запросе. |
| Bad Request | 400 | Invalid API key | Проверьте корректность введенного API ключа |
| Bad Request | 400 | Google/Yandex region xxx is not supported | Проверьте корректность id региона |
| Bad Request | 400 | cannot be converted to valid domain | Вы ввели невалидный домен. Проверьте его и введите валидный домен. |
| Bad Request | 400 | Region «ххх» is not valid for domain “хх» | Вы сделали ошибку при вводе параметра «type» – проверьте его и убедитесь, что регистр домена указан в правильном формате. |
| Bad Request | 400 | “xxx” is not supported Yandex / Google language | Вы сделали ошибку в параметре «lang». – Проверьте его и убедитесь, что язык указан в правильном формате. |
| Bad Request | 400 | Region device parameter must be either 0 or 1 | Вы сделали ошибку в параметре «device» Измените данные на 0 (десктоп) или 1 (мобайл) |
| Bad Request | 400 | API key not found in request | Добавьте API ключ в запрос. |
| Bad Request | 400 | All your keywords were filtered out by stopwords | Все ключевые слова были удалены стоп-словами. Проверьте ваши стоп слова и повторите запрос. |
| Bad request | 400 | Country missing from google region | Добавьте страну для указанного вами региона. Пример «.com» |
| Bad request | 400 | Country missing from youtube region | Добавьте страну для указанного вами региона. Пример «.com» |
| Bad request | 400 | Depth missing from parameters | Укажите глубину сбора поисковых подсказок «1-3» |
| Bad request | 400 | Empty URL | Задайте домен сайта для проверки позиций. |
| Bad request | 400 | Empty name | Укажите название задачи. |
| Internal Server Error | 500 | Error has occured, please try again later» . $e->getMessage() | Произошла ошибка. Проверьте запрос и повторите его еще раз. |
| Bad request | 400 | Failed to find project $projectid of type $projecttypeName | Задача не найдена. Повторите запрос еще раз или обратитесь в нашу службу поддержки. |
| Bad request | 400 | GoogleRegion missing from parameters | Укажите Google регион для вашей задачи. |
| Bad request | 400 | Invalid depth, allowed depths are » . join(‘,’, $allowedDepths) | Вы указали неверный параметр глубины сбора данных в поисковых подсказках. Замените его на 1-3 |
| Bad request | 400 | Keywords missing from parameters | Добавьте ключевые слова в задачу. |
| Bad request | 400 | Language missing from google region | Добавьте язык для Google региона. |
| Bad request | 400 | Language missing from youtube region | Добавьте язык для Youtube региона. |
| Bad request | 400 | Maximum keyword length is 2000 characters | В проверке позиций максимально допустимая длина ключевых слов 2000 символов. Уменьшите длину ваших ключевых слов. |
| Bad request | 400 | Missing apikey parameter | Добавьте API ключ в запрос. |
| Bad request | 400 | Name missing from parameters | Укажите название задачи. |
| Forbidden | 403 | Not allowed to create project through API | На вашем тарифном плане нет доступа к API. Перейдите на тариф с доступом к API. |
| Bad request | 400 | Not authorized | Не авторизированы. Обратитесь в нашу службу поддержки. |
| Bad request | 400 | Not enough limits. | На тарифном плане недостаточно лимитов для создания задачи. Докупите лимиты. |
| Bad request | 400 | Please choose at least one type of search volume: normal, parenthesis or exclamation | Для создания задачи необходимо установить хотя бы 1 из видов частотности как «true» |
| Bad request | 400 | Project does not exist | Задача не существует |
| Bad request | 400 | Project is not in done status | Задача в обработке. Повторите запрос позже. |
| Bad request | 400 | Project with ID $projectid of type $projecttype does not exist | Задача не существует |
| Bad request | 400 | Projecttype missing from parameters | Укажите PROJECTTYPE для задачи. |
| Bad request | 400 | Region missing from google region | Укажите id региона. |
| Bad request | 400 | Region missing from parameters | Регион сбора данных не указан. |
| Bad request | 400 | Regionid missing from parameters | Укажите id региона. |
| Bad request | 400 | Request body is not a valid JSON | Проверьте валидность вашего запроса. |
| Bad request | 400 | URL missing from parameters | Задайте домен сайта для проверки позиций. |
| Bad request | 400 | URLs missing from parameters | Задайте URL для проверки индексации. |
| Bad request | 400 | Unknown API function | Неизвестная API функция. |
| Bad request | 400 | Unknown project type ‘$projectTypeString’ | PROJECTTYPE задан не верно. Пример верных PROJECTTYPE для инструмента Wordstat «Keywords» или «SearchVolume» |
| Bad request | 400 | Unsupported search engine. Supported types: Google, Yandex | Поисковые системы, которые поддерживаются: «Yandex» и «Google» |
| Bad request | 400 | You must choose at least 1 keyword | Необходимо добавить ключевые слова в задачу. |
| Bad request | 400 | You must choose at least 1 region | Необходимо добавить как минимум 1 регион в задачу. |
| Bad request | 400 | You must fill at least one URL | Необходимо добавить URL в задачу для проверки индексации. |
| Bad request | 400 | You must input at least 1 keyword | Необходимо добавить ключевые слова в задачу. |
| Bad request | 400 | You must choose at least 1 keyword | Необходимо добавить ключевые слова в задачу. |
| Bad request | 400 | You must select at least one region type | Необходимо добавить как минимум 1 регион в задачу. |
| Bad request | 400 | You must select at least one search engine. Google or Yandex. | Необходимо добавить как минимум 1 поисковую систему. |
| Bad request | 400 | You need to select at least one region | Необходимо добавить как минимум 1 регион в задачу. |
| Bad request | 400 | googleCountry parameter is empty | Необходимо добавить параметр страны для проверки индексации сайта в Google |
| Bad request | 400 | googleLanguage parameter is empty | Необходимо добавить параметр языка для проверки индексации сайта в Google |