API интерфейс используется для того, чтобы интегрировать возможности сервиса Keys.so в личный проект клиента. API предназначен для разработчиков и сопровождается детальной документацией.
REST API сервиса работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.
Процесс авторизации возможен при наличии персонального ключа (далее токен), которым в дальнейшем должен быть подписан каждый запрос к API.
Токен можно сформировать в настройках личного кабинета в блоке API.
Токен автоматически будет обновлен в случае смены пароля пользователя или по нажатию кнопки "Сформировать новый токен".
Токен необходимо использовать как значение заголовка X-Keyso-TOKEN
для совершения авторизованных запросов.
Пример ключа:
X-Keyso-TOKEN: 5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5
Как альтернатива использованию токена в качестве значения заголовка, допускается использование параметра auth-token
в запросе
Пример:
&auth-token=5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5
Все ссылки на запросы к API в данной документации включают обязательный основной URL:
https://api.keys.so/
Большинство отчетов (если об этом не сказано отдельно) поддерживают стандартные параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
current_page |
integer |
false |
Порядковый номер страницы результатов |
1 |
per_page |
integer |
false |
Количество результатов на одной странице |
50 000 |
sort |
string |
false |
Сортировка данных по полям Формат:
Пример значения: pos|asc
Пример значения сортировки по двум полям: pos|asc,wsk|desc
|
none |
filter |
string |
false |
Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
none |
Механизм фильтрации используется вместе с параметрами запроса по умолчанию
Поля, которые поддерживают фильтрацию, перечислены в документации каждого отчета.
Тип поля | Условие | Оператор, формат |
string, integer |
Строго равен |
field |
string, integer |
Строго не равен |
field |
string |
Похож |
field |
string |
Не похож |
field |
string |
Начинается с |
field |
string |
Заканчивается |
field |
string, integer |
Не один из |
field |
string, integer |
Один из |
field |
integer |
Больше чем |
field |
integer |
Меньше чем |
field |
integer |
Больше или равно |
field |
integer |
Меньше или равно |
field |
integer |
Между |
field |
string |
Содержит |
field |
string |
Не содержит |
field |
Количество полей, участвующих в запросе на фильтрацию, не ограниченно.
Механизм поддерживает логические операторы И (^
) и ИЛИ (^OR
)
Перед отправкой, содержащая фильтр строка, должна быть URL кодирована
Пример составления запроса И (^
):
Отфильтровать все запросы, которые содержат слово "игрушка" c частотностью выше 170000 |
---|
Фильтр: wordLIKEигрушки^ws>170000 |
Параметры запроса: filter=wordLIKE%D0%B8%D0%B3%D1%80%D1%83%D1%88%D0%BA%D0%B8%5Ews%3E170000 |
Пример комбинации И (^
) и ИЛИ (^OR
):
Отфильтровать всех конкурентов, домен которых содержит слова "modа" или "kupi" c похожестью выше 40 |
---|
Фильтр: nameLIKEmoda^ORnameLIKEkupi^perc>50 |
Параметры запроса: filter=nameLIKEmoda%5EORnameLIKEkupi%5Eperc%3E50 |
Пример составления запроса c символом перевода строки(ввод нескольких значений) (%0A
):
Отфильтровать все урлы которые содержат /prodvizhenie-sajtov и /smm |
---|
Фильтр: urlREGEXP/prodvizhenie-sajtov%0A/smm |
Параметры запроса: filter=urlREGEXP%252Fprodvizhenie-sajtov%250A%252Fsmm |
Большинство отчетов (если об этом не сказано отдельно) содержит стандартную структуру ответа:
Поле | Тип | Описание |
current_page |
integer |
Порядковый номер страницы результатов |
per_page |
integer |
Количество результатов на одной странице |
last_page |
integer |
Номер последней страницы |
total |
integer |
Общее количество результатов |
data |
array |
Массив объектов, содержащих результат |
Пример ответа:
Код | Описание |
200 | Успешный запрос |
202 | Запрос был принят на обработку, но он не завершен. Повторите запрос позже. |
401 | Ошибка авторизации |
429 |
Исчерпан лимит запросов по текущему тарифному плану. Подробное описание ошибки доступно в поле message .В заголовке Retry-After ответа сервера указанно время (в секундах), через которое клиенту рекомендуется повторить запрос.
|
500 | Внутренняя ошибка сервера. Подробное описание ошибки доступно в поле message |
<?php /* * Пример получение данных на языке PHP с использованием cURL * */ $url = "https://api.keys.so/report/simple/context/concurents?base=msk&domain=foodband.ru&sort=cnt%7Cdesc&page=1&per_page=250"; $curl = curl_init(); $headers = array('X-Keyso-TOKEN: 5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5'); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_HEADER, true); curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 15); curl_setopt($curl, CURLOPT_TIMEOUT, 15); $response = curl_exec($curl); $header_size = curl_getinfo($curl, CURLINFO_HEADER_SIZE); $headerCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); $responseBody = substr($response, $header_size); curl_close($curl);
report/simple/domain_dashboard
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Пример запроса:
report/simple/domain_dashboard?base=msk&domain=wildberries.ru
Структура ответа:
Имя поля | Тип | Описание |
id |
integer |
Идентификатор домена |
name |
string |
Название домена |
isWP |
integer |
Домен на WordPress |
moevideo |
integer |
Идентификатор вебмастера в Moevideo
|
leadia |
integer |
Идентификатор вебмастера в Leadia
|
leetero |
integer |
Идентификатор вебмастера в Leetero
|
adsenseid |
string |
Идентификатор Google Adsense
|
analytics |
integer |
Идентификатор Google Analytics
|
relapio |
string |
Идентификатор вебмастера в Relap.io
|
parentid |
integer |
Идентификатор родительского домена, если домен является поддоменом |
parentName |
string |
Имя родительского домена, если домен является поддоменом
|
childsCount |
integer |
Количество поддоменов сайта |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
it1 |
integer |
Запросов в топ 1 |
it3 |
integer |
Запросов в топ 3 |
it5 |
integer |
Запросов в топ 5 |
it10 |
integer |
Запросов в топ 10 |
it50 |
integer |
Запросов в топ 50 |
restop5 |
integer |
Процент ключей из ТОП50, занимающий позиции в ТОП5 |
topvis |
integer |
По видимости |
topkeys |
integer |
По охвату ключей |
pagesinindex |
integer |
Страниц в выдаче |
vis |
integer |
Ориентировочное количество пользователей из органического поиска в сутки |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
adscnt |
integer |
Количество объявлений в контексте |
adkeyscnt |
integer |
Количество запросов в контексте |
keys |
array |
|
concs |
array |
|
pages |
array |
|
ads |
array |
|
adkeys |
array |
Контекстная реклама, ключевые слова сайта, первые 20 записей |
adconcs |
array |
|
adsenseidCount |
integer |
Сайты владельца, по Google Adsense |
leadiaCount |
integer |
Сайты владельца, по Leadia |
leeteroCount |
integer |
Сайты владельца, по Leetero |
analyticsCount |
integer |
Сайты владельца, по Google Analytics |
relapioCount |
integer |
Сайты владельца, по Relap.io |
moevideoCount |
integer |
Сайты владельца, по Moevideo |
history |
array |
(object) keys:
Имя поля | Тип | Описание |
word |
string |
Ключевая фраза |
ws |
integer |
Базовая частотность |
wsk |
integer |
[!Очень !точная !частотность] |
pos |
integer |
Позиция в выдаче |
(object) concs:
Имя поля | Тип | Описание |
name |
string |
Имя домена |
count |
integer |
Общих ключей в топ 50 |
adscnt |
integer |
Количество объявлений в контексте |
adkeyscnt |
integer |
Количество запросов в контексте |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
vis |
integer |
Оценка трафика с поиска |
(object) pages:
Имя поля | Тип | Описание |
id |
integer |
Идентификатор страницы |
url |
string |
URL страницы |
it50 |
integer |
Общих ключей в топ 50 |
(object) ads:
Имя поля | Тип | Описание |
id |
integer |
Идентификатор объявления |
header |
string |
Заголовок объявления |
txt |
string |
Текст объявления |
links |
string |
Быстрые ссылки |
facts |
string |
Факты |
keyscnt |
integer |
Количество запросов |
(object) adkeys:
Имя поля | Тип | Описание |
word |
string |
Ключевая фраза |
ws |
integer |
Базовая частотность |
wsk |
integer |
[!Очень !точная !частотность] |
pos |
integer |
Позиция в выдаче Возможные значения:
|
gr3bid |
integer |
Стоимость клика на входе в остальные показы |
(object) adconcs:
Имя поля | Тип | Описание |
name |
string |
Имя домена |
count |
integer |
Общих ключей в топ 50 |
adscnt |
integer |
Количество объявлений в контексте |
adkeyscnt |
integer |
Количество запросов в контексте |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
vis |
integer |
Оценка трафика с поиска |
(array) history:
array(
...,
"Дата обновления", "топ 1", "топ 3", "топ 5", "топ 10", "топ 50", "Страниц в поиске",
...
)
Пример ответа:
report/simple/keyword_dashboard
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
keyword |
string |
true |
поисковый запрос |
none |
Пример запроса:
report/simple/keyword_dashboard?keyword=%D0%9F%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5%20%D0%BE%D0%BA%D0%BD%D0%B0&base=msk
Структура ответа:
Имя поля | Тип | Описание |
id |
integer |
Идентификатор ключевого слова |
word |
string |
Ключевая фраза |
ws |
integer |
Базовая частотность |
wsk |
integer |
[!Очень !точная !частотность] |
top |
array |
|
ads |
object(key: type, value: array) |
Где type:
|
similar |
array |
Дополняющие фразы, первые 20 записей
|
(object) top:
Имя поля | Тип | Описание |
pos |
integer |
Позиция |
domain |
string |
Название домена |
url |
string |
Целевая страница |
it1, it3, it5, it10, it50 |
integer |
Запросы сайта в топ 1, топ 3, топ 5, топ 10, топ 50 |
pit1, pit5, pit10, pit50 |
integer |
Запросы страниц в топ 1, топ 5, топ 10, топ 50 |
adsenseid |
string |
Идентификатор издателя Google Adsense |
analytics |
integer |
Идентификатор в Google Analytics |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
vis |
integer |
Оценка трафика с поиска |
(object) ads:
Имя поля | Тип | Описание |
pos |
integer |
Позиция |
domain |
string |
Название домена |
header |
string |
Заголовок объявления |
txt |
string |
Текст объявления |
links |
array |
Массив быстрых ссылок |
facts |
array |
Массив фактов |
adscnt |
integer |
Количество объявлений в контексте |
adkeyscnt |
integer |
Количество запросов в контексте |
(object) similar:
Имя поля | Тип | Описание |
word |
string |
Ключевая фраза |
cnt |
integer |
Степень похожести запроса на исходный |
ws |
integer |
Базовая частотность |
wsk |
integer |
[!Очень !точная !частотность] |
docs |
integer |
Количество документов в выдаче |
pr0amn |
integer |
Прогноз списываемой суммы на первом месте Спец Размещения |
pr0ctr |
double |
Прогноз CTR на первом месте Спец Размещения |
Пример ответа:
report/simple/context/keywords
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
header |
string |
Заголовок объявления |
true |
txt |
string |
Текст объявления |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
pos |
integer |
Позиция в контексте |
true |
sr |
integer |
Блок размещения объявлений Возможные значения:
|
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
avbid |
integer |
Средняя цена клика |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/simple/context/keywords/byads
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
ads_id |
integer |
true |
Идентификатор объявления
|
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/keywords/byads?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
header |
string |
Заголовок объявления |
true |
txt |
string |
Текст объявления |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
pos |
integer |
Позиция в контексте |
true |
sr |
integer |
Блок размещения объявлений Возможные значения:
|
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
avbid |
integer |
Средняя цена клика |
true |
docs |
integer |
Количество документов в выдаче |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/simple/context/ads
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
full |
boolean |
false |
Если |
false |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/ads?base=msk&domain=wildberries.ru&sort=keyscnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
id |
integer |
Идентификатор объявления
|
false |
header |
string |
Заголовок объявления |
true |
txt |
string |
Текст объявления |
true |
links |
array |
Массив быстрых ссылок |
true |
facts |
array |
Массив фактов |
true |
keyscnt |
integer |
Количество запросов |
true |
keys |
array |
Массив ключевых слов, поле доступно при добавлении параметра full (см. параметры запроса) |
false |
Пример ответа:
report/simple/context/ads/links
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/ads/links?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
links |
string |
Уникальные ссылки |
true |
Пример ответа:
report/simple/context/ads/facts
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/ads/facts?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
links |
string |
Уникальные факты |
true |
Пример ответа:
report/simple/context/concurents
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/context/concurents?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
name |
string |
Имя домена |
true |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
true |
theme |
double |
Тематичность домена (% ключей анализируемого домена в ключах домена) |
true |
cnt |
integer |
Общих ключей в топ 50 |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
true |
adsenseid |
string |
Идентификатор издателя Google Adsense
|
false |
analytics |
integer |
Идентификатор в Google Analytics
|
false |
relapio |
string |
Идентификатор вебмастера в Relap.io
|
false |
vis |
integer |
Оценка трафика с поиска |
false |
adscnt |
integer |
Количество объявлений в контексте |
true |
adkeyscnt |
integer |
Количество запросов в контексте |
true |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
false |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
false |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
false |
moevideo |
integer |
Идентификатор вебмастера в MoeVideo
|
false |
leadia |
integer |
Идентификатор вебмастера в Leadia
|
false |
leetero |
integer |
Идентификатор вебмастера в Leetero
|
false |
Пример ответа:
report/simple/organic/keywords
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/organic/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
url |
string |
Страница, представленная в выдаче
|
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
pos |
integer |
Занимаемая позиция в SERP |
true |
kei |
integer |
Индекс эффективности ключевой фразы. Максимальное значение - 99. Только для Яндекс. |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
avbid |
integer |
Средняя цена клика |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/simple/organic/sitepages
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/organic/sitepages?base=msk&domain=wildberries.ru&sort=it50%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
url |
string |
Адрес страницы сайта
|
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
vis |
integer |
Оценка видимости страницы в поиске. Чем больше - тем больше потенциал трафика на страницу |
true |
Пример ответа:
report/simple/organic/keywords/bypage
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
page_url |
string |
true |
Url страницы
|
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/organic/keywords/bypage?base=msk&domain=wildberries.ru&page_url=%2Fbrands%2Fadidas&sort=pos%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
pos |
integer |
Занимаемая позиция в SERP |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
avbid |
integer |
Средняя цена клика |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/simple/organic/concurents
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/organic/concurents?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
name |
string |
Имя домена |
true |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
true |
theme |
double |
Тематичность домена (% ключей анализируемого домена в ключах домена) |
true |
cnt |
integer |
Общих ключей в топ 50 |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
true |
adsenseid |
string |
Идентификатор издателя Google Adsense
|
false |
analytics |
integer |
Идентификатор в Google Analytics
|
false |
relapio |
string |
Идентификатор вебмастера в Relap.io
|
false |
vis |
integer |
Оценка трафика с поиска |
false |
adscnt |
integer |
Количество объявлений в контексте |
true |
adkeyscnt |
integer |
Количество запросов в контексте |
true |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
false |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
false |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
false |
moevideo |
integer |
Идентификатор вебмастера в MoeVideo
|
false |
leadia |
integer |
Идентификатор вебмастера в Leadia
|
false |
leetero |
integer |
Идентификатор вебмастера в Leetero
|
false |
Пример ответа:
report/simple/organic/concurent_pages
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
domain |
string |
true |
Имя домена |
none |
page_url |
string |
true |
Url страницы
|
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/organic/concurent_pages?base=msk&domain=wildberries.ru&page_url=%2Fbrands%2Fadidas&sort=pos%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
domain |
string |
Имя домена |
true |
url |
string |
URL страницы |
true |
perc |
double |
Степень похожести страницы (% общих ключей от ключей анализируемой страницы) |
true |
theme |
double |
Тематичность страницы (% ключей анализируемой страницы в ключах страницы) |
true |
cnt |
integer |
Общих ключей в топ 50 |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
Пример ответа:
report/simple/similarkeys
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
base |
string |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
none |
keyword |
string |
true |
поисковый запрос |
none |
Стандартные параметры запроса |
Пример запроса:
report/simple/similarkeys?base=msk&keyword=%D0%BF%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5%20%D0%BE%D0%BA%D0%BD%D0%B0
&sort=wsk%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
cnt |
integer |
Степень похожести запроса на исходный |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
docs |
integer |
Количество документов в выдаче |
true |
avbid |
integer |
Средняя цена клика |
true |
Пример ответа:
report/owner/{mode}
Возможные значения {mode}:
analytics
- поиск по идентификатору Google Analyticsadsense
- поиск по идентификатору Google Adsenseleadia
- поиск по идентификатору Leadiamoevideo
- поиск по идентификатору Moevideoleetero
- поиск по идентификатору Leeterorelapio
- поиск по идентификатору Relap.iosubdomains
- поиск субдоменов по доменуПараметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
id |
string |
true |
В зависимости от {mode}:
|
none |
Стандартные параметры запроса |
Пример запроса:
report/owner/subdomains?id=wildberries.ru&sort=name%7Casc&page=1&per_page=25
report/owner/analytics?id=27827341&sort=name%7Casc&page=1&per_page=25
report/owner/relapio?id=TEI7T7IxrnrKms&sort=name%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
name |
string |
Имя домена |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
true |
adsenseid |
string |
Идентификатор издателя Google Adsense |
false |
analytics |
integer |
Идентификатор в Google Analytics |
false |
relapio |
string |
Идентификатор вебмастера в Relap.io |
false |
vis |
integer |
Оценка трафика с поиска |
false |
adscnt |
integer |
Количество объявлений в контексте |
true |
adkeyscnt |
integer |
Количество запросов в контексте |
true |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
false |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
false |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
false |
moevideo |
integer |
Идентификатор вебмастера в MoeVideo |
false |
leadia |
integer |
Идентификатор вебмастера в Leadia |
false |
leetero |
integer |
Идентификатор вебмастера в Leetero |
false |
Пример ответа:
report/keywords
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
page |
integer |
false |
Порядковый номер страницы результатов |
1 |
per_page |
integer |
false |
Количество результатов на одной странице |
50 000 |
sort |
string |
false |
Сортировка данных по полям Формат:
Пример значения: pos|asc
Пример значения сортировки по двум полям: pos|asc,wsk|desc
|
none |
filter |
string |
false |
Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных |
none |
Пример запроса:
report/keywords?sort=wsk%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/group
Тело запроса:
Имя поля | Тип | Обязательный | Описание |
base |
String |
true |
Региональная база данных, по которой происходит выборка Возможные значения:
|
domains |
array |
true |
Массив доменов в отчете |
name |
String |
false |
Имя отчета |
Пример запроса:
Структура ответа:
Имя поля | Тип | Описание |
rid |
string |
Идентификатор отчета |
Пример ответа:
report/group/organic/keywords/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/organic/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=wsk%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Ключевая фраза |
true |
weight |
integer |
Количество сайтов-конкурентов в топ50 |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
numwords |
integer |
Количество слов в запросе |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/group/organic/concurents/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/organic/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
name |
string |
Имя домена |
true |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
true |
cnt |
integer |
Общих ключей в топ 50 |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
true |
adsenseid |
string |
Идентификатор издателя Google Adsense
|
false |
analytics |
integer |
Идентификатор в Google Analytics
|
false |
relapio |
string |
Идентификатор вебмастера в Relap.io
|
false |
vis |
integer |
Оценка трафика с поиска |
false |
adscnt |
integer |
Количество объявлений в контексте |
true |
adkeyscnt |
integer |
Количество запросов в контексте |
true |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
false |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
false |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
false |
moevideo |
integer |
Идентификатор вебмастера в MoeVideo
|
false |
leadia |
integer |
Идентификатор вебмастера в Leadia
|
false |
leetero |
integer |
Идентификатор вебмастера в Leetero
|
false |
Пример ответа:
report/group/organic/sitepages/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/organic/sitepages/696b62ec6bceaf00529c4dd4bce02b47?sort=vis%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
pid |
integer |
Идентификатор страницы
|
false |
domain |
string |
Имя домена |
true |
url |
string |
Адрес страницы сайта |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
vis |
integer |
Оценка видимости страницы в поиске. Чем больше - тем больше потенциал трафика на страницу |
true |
Пример ответа:
report/group/context/keywords/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/context/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=weight%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
weight |
integer |
Количество сайтов-конкурентов (из числа сайтов в отчете) в контексте |
true |
ws |
integer |
Базовая частотность |
true |
ws |
integer |
Базовая частотность |
true |
wsk |
integer |
[!Очень !точная !частотность] |
true |
s0amn |
integer |
Стоимость клика на позиции 1 премиум блока, руб |
true |
s0ctr |
double |
CTR на позиции 1 премиум блока |
true |
gamn |
integer |
Стоимость клика на позиции вход в остальные показы, руб. |
true |
gctr |
double |
CTR на позиции вход в остальные показы |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
Пример ответа:
report/group/context/concurents/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/context/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
name |
string |
Имя домена |
true |
perc |
double |
Степень похожести домена (% общих ключей от ключей домена) |
true |
cnt |
integer |
Общих ключей в топ 50 |
true |
it1 |
integer |
Запросов в топ 1 |
true |
it3 |
integer |
Запросов в топ 3 |
true |
it5 |
integer |
Запросов в топ 5 |
true |
it10 |
integer |
Запросов в топ 10 |
true |
it50 |
integer |
Запросов в топ 50 |
true |
pagesinindex |
integer |
Количество страниц сайта, найденных в выдаче |
true |
adsenseid |
string |
Идентификатор издателя Google Adsense
|
false |
analytics |
integer |
Идентификатор в Google Analytics
|
false |
relapio |
string |
Идентификатор вебмастера в Relap.io
|
false |
vis |
integer |
Оценка трафика с поиска |
false |
adscnt |
integer |
Количество объявлений в контексте |
true |
adkeyscnt |
integer |
Количество запросов в контексте |
true |
adtraf |
integer |
Оценка трафика из контекста без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, разделенное на 30 дней |
false |
adcost |
integer |
Оценка бюджета без учета каких-либо таргетингов. Произведение точной частотности, на прогноз CTR, на стоимость клика, разделенное на 30 дней |
false |
rsya |
integer |
Наличие Рекламной Сети Яндекса |
false |
moevideo |
integer |
Идентификатор вебмастера в MoeVideo
|
false |
leadia |
integer |
Идентификатор вебмастера в Leadia
|
false |
leetero |
integer |
Идентификатор вебмастера в Leetero
|
false |
Пример ответа:
report/group/context/ads/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/context/ads/696b62ec6bceaf00529c4dd4bce02b47?sort=keyscnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
aid |
integer |
Идентификатор объявления
|
false |
domain |
string |
Имя домена |
true |
header |
string |
Заголовок объявления |
true |
txt |
string |
Текст объявления |
true |
links |
array |
Массив быстрых ссылок |
true |
facts |
array |
Массив фактов |
true |
keyscnt |
integer |
Количество запросов |
true |
Пример ответа:
report/group/context/ads/links/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/context/ads/links/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
links |
string |
Уникальные ссылки |
true |
Пример ответа:
report/group/context/ads/facts/{rid}
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
rid |
string |
true |
Идентификатор отчета |
none |
Стандартные параметры запроса |
Пример запроса:
report/group/context/ads/facts/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание | Фильтр |
links |
string |
Уникальные факты |
true |
Пример ответа:
limits/all
Структура ответа:
Имя поля | Тип | Описание |
analysis |
object |
Анализируемых доменов|фраз|каналов в сутки limit - int - Установленный лимит для тарифа usedLimit - int - Использований |
apiRequest |
object |
Запросов к API в сутки limit - int - Установленный лимит для тарифа usedLimit - int - Использований |
users |
object |
Пользователей можно пригласить limit - int - Установленный лимит для тарифа usedLimit - int - Использований |
keysReportLimit |
object |
Макс. кол-во запросов у сайта, при котором построится групповой отчёт limit - int - Установленный лимит для тарифа |
recordsPerReport |
object |
Записей в отчётах limit - int - Установленный лимит для тарифа |
sitesCompare |
object |
Макс. сайтов в сравнении limit - int - Установленный лимит для тарифа |
Пример ответа:
tools/delete_double
Тело запроса:
Имя поля | Тип | Обязательный | Описание |
list |
array |
true |
Массив фраз для чистки дублей |
Пример запроса:
Структура ответа:
Имя поля | Тип | Описание |
keys |
array |
Ключи |
exclude |
array |
Ключи которые были исключены |
Пример ответа:
tools/extended_keywords
Тело запроса:
Имя поля | Тип | Обязательный | Описание | Значение по умолчанию |
list |
array |
true |
Массив фраз |
[] |
config |
object |
false |
Настройки similarity - int - похожесть (от 5 до 100, шаг 1) deleteDuplicate - bool - без повторов additions - bool - добавить "хвосты" исходных фраз |
|
base |
string |
false |
Региональная база данных, по которой происходит выборка Возможные значения:
|
msk |
Пример запроса:
Структура ответа:
Имя поля | Тип | Описание |
uid |
string |
Идентификатор отчета |
Пример ответа:
tools/extended_keywords/state/полученный UID
Структура ответа:
Имя поля | Тип | Описание |
state |
int |
Состояние: 0 - создан 1 - взят в обработку 10 - готов |
progress |
int |
Прогресс в процентах (0 до 100) |
Пример ответа:
tools/extended_keywords/полученный UID
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
page |
integer |
false |
Порядковый номер страницы результатов |
1 |
per_page |
integer |
false |
Количество результатов на одной странице |
50 000 |
sort |
string |
false |
Сортировка данных по полям Формат:
Пример значения: pos|asc
Пример значения сортировки по двум полям: pos|asc,wsk|desc
|
none |
filter |
string |
false |
Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных |
none |
Пример запроса:
tools/extended_keywords/7d9a401359df946e37cbebfc937a5d65?sort=wsk%7Casc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание |
current_page |
integer |
Текущая страница |
per_page |
integer |
Элементов на странице |
last_page |
integer |
Последняя страница |
total |
integer |
Всего элементов |
data |
array |
Данные по фразам |
Массив data:
Имя поля | Тип | Описание | Фильтр |
source_key |
string |
Целевой запрос |
true |
destination_key |
string |
Запрос |
true |
ws |
integer |
Базовая частотность для все регионов кроме Google: New York |
true |
frequency |
integer |
Базовая частотность для Google: New York |
true |
wsk |
integer |
[!Очень !точная !частотность] для все регионов кроме Google: New York |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
addition |
boolean |
Хвост |
true |
cnt |
integer |
Похожесть, % |
true |
avbid |
integer |
Цена клика для баз Яндекса |
true |
maxcpc |
integer |
Максимальная цена клика, только для Google: New York |
true |
mincpc |
integer |
Минимальная цена клика, только для Google: New York |
true |
Пример ответа:
tools/keywords_by_list
Тело запроса:
Имя поля | Тип | Обязательный | Описание | Значение по умолчанию |
list |
array |
true |
Массив фраз |
[] |
base |
string |
false |
Региональная база данных, по которой происходит выборка Возможные значения:
|
msk |
Пример запроса:
Структура ответа:
Имя поля | Тип | Описание |
uid |
string |
Идентификатор отчета |
Пример ответа:
tools/keywords_by_list/полученный UID
Параметры запроса:
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
page |
integer |
false |
Порядковый номер страницы результатов |
1 |
per_page |
integer |
false |
Количество результатов на одной странице |
50 000 |
sort |
string |
false |
Сортировка данных по полям Формат:
Пример значения: pos|asc
Пример значения сортировки по двум полям: pos|asc,wsk|desc
|
none |
filter |
string |
false |
Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных |
none |
Пример запроса:
tools/keywords_by_list/msk:44:6684baecf18566c4381fc7731925481d?base=msk&sort=wsk%7Cdesc&page=1&per_page=25
Стандартная структура ответа:
Имя поля | Тип | Описание |
current_page |
integer |
Текущая страница |
per_page |
integer |
Элементов на странице |
last_page |
integer |
Последняя страница |
total |
integer |
Всего элементов |
data |
array |
Данные по фразам |
Массив data:
Имя поля | Тип | Описание | Фильтр |
word |
string |
Запрос |
true |
ws |
integer |
Базовая частотность для все регионов кроме Google: New York |
true |
frequency |
integer |
Базовая частотность для Google: New York |
true |
wsk |
integer |
[!Очень !точная !частотность] для все регионов кроме Google: New York |
true |
numwords |
integer |
Количество слов в запросе |
true |
adscnt |
integer |
Количество объявлений |
true |
docs |
integer |
Количество документов в выдаче |
true |
isgeo |
integer |
Является топонимом |
true |
isquest |
integer |
Является вопросом |
true |
avbid |
integer |
Цена клика для баз Яндекса |
true |
maxcpc |
integer |
Максимальная цена клика, только для Google: New York |
true |
mincpc |
integer |
Минимальная цена клика, только для Google: New York |
true |
serpf |
string |
Дата |
true |
Пример ответа:
/clustering
Тело запроса:
Имя поля | Тип | Обязательный | Описание | Значение по умолчанию |
list |
array |
true |
Массив фраз |
[] |
base |
string |
false |
Региональная база данных, по которой происходит выборка Возможные значения:
|
msk |
Пример запроса:
Структура ответа:
Имя поля | Тип | Описание |
uid |
string |
Идентификатор отчета |
Пример ответа:
/clustering/полученный UID/build
Тело запроса:
Имя поля | Тип | Обязательный | Описание |
topNumber |
integer |
true |
Глубина проверки(топ 10, 20, 50) |
fStrength |
integer |
false |
более общее\мелкие группы(%) |
fIsWsk |
boolean |
false |
Минимальная [!частотность] главного ключа в группе(использовать или нет) |
fWsk |
integer |
false |
Минимальная [!частотность] главного ключа в группе(значение) |
fIsSumWsk |
boolean |
false |
Минимальная суммарная [!частотность] группы(использовать или нет) |
fSumWsk |
boolean |
false |
Минимальная суммарная [!частотность] группы(значение); |
Пример запроса:
Структура ответа:
Тип | Описание |
boolean |
Успешность постановки на кластеризацию |
Пример ответа: