Документация REST API сервиса Keys.so

Описание REST API сервиса

Краткое описание

API интерфейс используется для того, чтобы интегрировать возможности сервиса Keys.so в личный проект клиента. API предназначен для разработчиков и сопровождается детальной документацией.

REST API сервиса работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.

Авторизация

Процесс авторизации возможен при наличии персонального ключа (далее токен), которым в дальнейшем должен быть подписан каждый запрос к API.

Токен можно сформировать в настройках личного кабинета в блоке API.

Токен автоматически будет обновлен в случае смены пароля пользователя или по нажатию кнопки "Сформировать новый токен".

Токен необходимо использовать как значение заголовка X-Keyso-TOKEN для совершения авторизованных запросов.

Пример ключа:

X-Keyso-TOKEN: 5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5

Как альтернатива использованию токена в качестве значения заголовка, допускается использование параметра auth-token в запросе

Пример:

&auth-token=5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5

Основной URL

Все ссылки на запросы к API в данной документации включают обязательный основной URL: https://api.keys.so/

Стандартные параметры запроса

Большинство отчетов (если об этом не сказано отдельно) поддерживают стандартные параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
current_page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Фильтрация данных	none

Механизм фильтрации данных

Механизм фильтрации используется вместе с параметрами запроса по умолчанию

Поля, которые поддерживают фильтрацию, перечислены в документации каждого отчета.

Тип поля	Условие	Оператор, формат
string, integer	Строго равен	field`=`value
string, integer	Строго не равен	field`!=`value
string	Похож	field`LIKE`value
string	Не похож	field`NOT LIKE`value
string	Начинается с	field`STARTSWITH`value
string	Заканчивается	field`ENDSWITH`value
string, integer	Не один из	field`IN`valueA,valueB
string, integer	Один из	field`NOT IN`valueA,valueB
integer	Больше чем	field`>`value
integer	Меньше чем	field`<`value
integer	Больше или равно	field`>=`value
integer	Меньше или равно	field`<=`value
integer	Между	field`BETWEEN`valueA@valueB
string	Содержит	field`REGEXP`value
string	Не содержит	field`NOT REGEXP`value

Количество полей, участвующих в запросе на фильтрацию, не ограниченно.

Механизм поддерживает логические операторы И (^) и ИЛИ (^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`

Структура ответа JSON

Большинство отчетов (если об этом не сказано отдельно) содержит стандартную структуру ответа:

Поле	Тип	Описание
current_page	integer	Порядковый номер страницы результатов
per_page	integer	Количество результатов на одной странице
last_page	integer	Номер последней страницы
total	integer	Общее количество результатов
data	array	Массив объектов, содержащих результат

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":29296,"data":[{}],"total":732392}

Коды ответов сервера

Код	Описание
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);

Описание REST API простых отчетов

Информация о домене (Дэшборд)

GET `report/simple/domain_dashboard`

Параметры запроса:

Параметр Тип Обязательный Описание Значение по умолчанию

base

string

true

Региональная база данных, по которой происходит выборка

Возможные значения:

zen - Дзен
msk - Яндекс: Москва
gru - Google: Москва
spb - Яндекс: Санкт-Петербург
ekb - Яндекс: Екатеринбург
krr - Яндекс: Краснодар
nnv - Яндекс: Н. Новгород
rnd - Яндекс: Ростов-на-Дону
gkv - Google: Киев
mns - Яндекс: Минск
gmns - Google: Минск
kzn - Яндекс: Казань
oms - Яндекс: Омск
vlg - Яндекс: Волгоград
nsk - Яндекс: Новосибирск
che - Яндекс: Челябинск
sam - Яндекс: Самара
ufa - Яндекс: Уфа
kry - Яндекс: Красноярск
prm - Яндекс: Пермь
vrn - Яндекс: Воронеж
sar - Яндекс: Саратов
gny - Google: New York

none

domain

string

true

Имя домена

none

Пример запроса:

report/simple/domain_dashboard?base=msk&domain=wildberries.ru

Структура ответа:

Имя поля	Тип	Описание
id	integer	Идентификатор домена
name	string	Название домена
isWP	integer	Домен на WordPress
moevideo	integer	Идентификатор вебмастера в Moevideo `Cвязанный отчет: Сайты владельца`
leadia	integer	Идентификатор вебмастера в Leadia `Cвязанный отчет: Сайты владельца`
leetero	integer	Идентификатор вебмастера в Leetero `Cвязанный отчет: Сайты владельца`
adsenseid	string	Идентификатор Google Adsense `Cвязанный отчет: Сайты владельца`
analytics	integer	Идентификатор Google Analytics `Cвязанный отчет: Сайты владельца`
relapio	string	Идентификатор вебмастера в Relap.io `Cвязанный отчет: Сайты владельца`
parentid	integer	Идентификатор родительского домена, если домен является поддоменом
parentName	string	Имя родительского домена, если домен является поддоменом `Cвязанный отчет: Сайты владельца`
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	Органическая выдача, ключевые фразы, первые 20 записей
concs	array	Органическая выдача, конкуренты, первые 20 записей
pages	array	Органическая выдача, страницы, первые 20 записей
ads	array	Контекстная реклама, объявления, первые 20 записей
adkeys	array	Контекстная реклама, ключевые слова сайта, первые 20 записей
adconcs	array	Контекстная реклама, конкуренты, первые 20 записей
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	Позиция в выдаче Возможные значения: `1` - СР1 `2` - СР2 `3` - СР3 `4` - Д1 `5` - Д2 `6` - Д3 `7` - Д4 `8` - Д5 `остальные значения` - Д6
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", "Страниц в поиске",

                ...
            )

Пример ответа:

            {"id":29918348,"name":"wildberries.ru","isWP":0,"moevideo":0,"leadia":0,"parentid":0,"parentName":"","childsCount":18,"leetero":0,"rsya":0,"adsenseid":"","analytics":0,"relapio":"","it1":86990,"it3":302770,"it5":455279,"it10":742944,"it50":1683529,"restop5": 27,"topvis":141,"topkeys":99,"pagesinindex":117711,"vis":110373,"adtraf":33507,"adcost":1110959,"adscnt":16075,"adkeyscnt":732392,"keys":[{"word":"интернет магазин","wsk":185018,"ws":31497995,"pos":1},{"word":"вилдберрис каталог интернет магазин","wsk":161666,"ws":169765,"pos":1}],"concs":[{"name":"yandex.ru","count":1304735,"adscnt":107,"adkeyscnt":32033,"vis":9013545,"perc":2.23},{"name":"market.yandex.ru","count":1185991,"adscnt":605,"adkeyscnt":36005,"vis":964188,"perc":9.87}],"pages":[{"id":27,"url":"/","it50":6918},{"id":1424,"url":"/content/size.html","it50":5321}],"ads":[{"id":312,"header":"Интернет-магазин одежды – WILDBERRIES","txt":"Более 7000 брендов. Осень 2017. Бесплатная курьерская доставка по всей России!","links":"Детская одежда|Женская одежда|Мужская одежда|Обувь","facts":"800 пунктов самовывоза|Акции каждый день|Более 10 лет на рынке","keyscnt":5739},{"id":77,"header":"Модные шапки - коллекция 2017 – Более 30000 моделей","txt":"Скидки до 70% бесплатная курьерская доставка по России","links":"Шапки для детей|Шапки для женщин|Шапки для мужчин","facts":"","keyscnt":4936}],"adkeys":[{"word":"вайлдберриз","wsk":499918,"ws":763146,"pos":0,"gr3bid":65},{"word":"wildberries","wsk":217815,"ws":627020,"pos":0,"gr3bid":91}],"adconcs":[{"name":"lamoda.ru","count":436412,"adscnt":44592,"adkeyscnt":1099981,"vis":3520115,"perc":39.67},{"name":"kupivip.ru","count":132153,"adscnt":57149,"adkeyscnt":282930,"vis":2378051,"perc":46.71}],"adsenseidCount":0,"leadiaCount":0,"leeteroCount":0,"analyticsCount":0,"relapioCount":0,"moevideoCount":0, "history": [ "2017.11",86990,302770,455279,742944,1683529,117711]}

Информация о ключевом слове (Дэшборд)

GET `report/simple/keyword_dashboard`

Параметры запроса:

Параметр Тип Обязательный Описание Значение по умолчанию

base

string

true

Региональная база данных, по которой происходит выборка

Возможные значения:

zen - Дзен
msk - Яндекс: Москва
gru - Google: Москва
spb - Яндекс: Санкт-Петербург
ekb - Яндекс: Екатеринбург
krr - Яндекс: Краснодар
nnv - Яндекс: Н. Новгород
rnd - Яндекс: Ростов-на-Дону
gkv - Google: Киев
mns - Яндекс: Минск
gmns - Google: Минск
kzn - Яндекс: Казань
oms - Яндекс: Омск
vlg - Яндекс: Волгоград
nsk - Яндекс: Новосибирск
che - Яндекс: Челябинск
sam - Яндекс: Самара
ufa - Яндекс: Уфа
kry - Яндекс: Красноярск
prm - Яндекс: Пермь
vrn - Яндекс: Воронеж
sar - Яндекс: Саратов
gny - Google: New York

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: `pr` - Блок спецразмещения `gr` - Блок гарантированных показов
similar	array	Дополняющие фразы, первые 20 записей `Cвязанный отчет: Ключевые слова - дополняющие фразы`

(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 на первом месте Спец Размещения

Пример ответа:

            {"id":36169671,"word":"пластиковые окна","ws":1090895,"wsk":35169,"docs":38000000,"top":[{"pos":1,"domain":"vekamoscow.ru","url":"/windows-calc/","it1":77,"it3":277,"it5":475,"it10":1202,"it50":4517,"pit1":10,"pit5":86,"pit10":265,"pit50":729,"adsenseid":"0","analytics":65128131,"pagesinindex":152,"vis":276}],"ads":{"gr":[{"pos":0,"domain":"eurookna.ru","header":"Пластиковые окна со скидкой 50%! – Срок службы 50 лет","txt":"От 4800р. В подарок мультифункциональный стеклопакет! Окна Veka с завода.","adscnt":1746,"adkeyscnt":5690,"facts":[],"links":["SALE","Оконный калькулятор","Отзывы клиентов","Финальная скидка 50%"]}],"pr":[{"pos":0,"domain":"okna-home.com","header":"Пластиковые окна КАЛЕВА! – Скидка 23%! От производителя!","txt":"Окна от производителя. Индикатор погоды METEOGLASS в подарок! Замер 0 руб. Звоните!","adscnt":428,"adkeyscnt":1613,"facts":["Монтаж по ГОСТ","Офисы по всей Москве","Рассрочка 0%"],"links":["Акции КАЛЕВА","Бесплатный замер","Калькулятор окна","Модели окон"]}]},"similar":[{"word":"пластиковые окна бесплатно","wsk":12,"cnt":"31","ws":1958,"docs":111000000,"pr0amn":32,"pr0ctr":6.9257950530035}]}

Контекстная реклама - ключевые слова

GET `report/simple/context/keywords`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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	Блок размещения объявлений Возможные значения: `1` - Блок спецразмещения `0` - Блок гарантированных показов	true
numwords	integer	Количество слов в запросе	true
adscnt	integer	Количество объявлений	true
docs	integer	Количество документов в выдаче	true
avbid	integer	Средняя цена клика	true
isgeo	integer	Является топонимом	true
isquest	integer	Является вопросом	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"бенеттон официальный сайт","header":"","txt":"","pos":0,"ws":17105,"wsk":11172,"docs":73000000,"avbid":40,"numwords":3,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Контекстная реклама - ключевые слова по объявлению

GET `report/simple/context/keywords/byads`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
ads_id	integer	true	Идентификатор объявления `Доступен в отчетах "Контекстная реклама - объявления"`	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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	Блок размещения объявлений Возможные значения: `1` - Блок спецразмещения `0` - Блок гарантированных показов	true
numwords	integer	Количество слов в запросе	true
adscnt	integer	Количество объявлений	true
docs	integer	Количество документов в выдаче	true
avbid	integer	Средняя цена клика	true
docs	integer	Количество документов в выдаче	true
isgeo	integer	Является топонимом	true
isquest	integer	Является вопросом	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"бенеттон официальный сайт","header":"","txt":"","pos":0,"ws":17105,"wsk":11172,"docs":73000000,"avbid":40,"numwords":5,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Контекстная реклама - объявления

GET `report/simple/context/ads`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
full	boolean	false	Если `true`, в отчет будет добавлен массив ключевых слов по каждому объявлению	false
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/simple/context/ads?base=msk&domain=wildberries.ru&sort=keyscnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
id	integer	Идентификатор объявления `Cвязанный отчет: Контекстная реклама - ключевые слова по объявлению`	false
header	string	Заголовок объявления	true
txt	string	Текст объявления	true
links	array	Массив быстрых ссылок	true
facts	array	Массив фактов	true
keyscnt	integer	Количество запросов	true
keys	array	Массив ключевых слов, поле доступно при добавлении параметра full (см. параметры запроса)	false

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"id":9222,"header":"Установки пластиковых окон в доме","txt":"Остекление домов от производителя. Гарантируем качество. Скидка 25%","links":["Калькулятор стоимости окна","Каталог профилей","Тёплое остекление"],"facts":["Собственное производство","Монтаж","Гарантия 5 лет"],"keyscnt":1,"keys":["стоимость установки пластиковых окон в деревянном доме"]}],"total":1}

Контекстная реклама - объявления, уникальные ссылки

GET `report/simple/context/ads/links`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/simple/context/ads/links?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
links	string	Уникальные ссылки	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"links":"Вечерние платья"}],"total":1}

Контекстная реклама - объявления, уникальные факты

GET `report/simple/context/ads/facts`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/simple/context/ads/facts?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
links	string	Уникальные факты	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"facts":"Более 10 лет на рынке"}],"total":1}

Контекстная реклама - конкуренты

GET `report/simple/context/concurents`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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 `Cвязанный отчет: Сайты владельца`	false
analytics	integer	Идентификатор в Google Analytics `Cвязанный отчет: Сайты владельца`	false
relapio	string	Идентификатор вебмастера в Relap.io `Cвязанный отчет: Сайты владельца`	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 `Cвязанный отчет: Сайты владельца`	false
leadia	integer	Идентификатор вебмастера в Leadia `Cвязанный отчет: Сайты владельца`	false
leetero	integer	Идентификатор вебмастера в Leetero `Cвязанный отчет: Сайты владельца`	false

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"name":"likewear.ru","perc":48,"theme":4,"cnt":32134,"it1":935,"it3":5531,"it5":12758,"it10":46597,"it50":311535,"pagesinindex":63411,"adsenseid":"5208752224013728","analytics":47482317,"relapio":"0","vis":1442,"adscnt":6868,"adkeyscnt":67538,"adtraf":1442,"adcost":19841,"rsya":0,"moevideo":0,"leadia":0,"leetero":0}],"total":1}

Органическая выдача - ключевые слова

GET `report/simple/organic/keywords`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/simple/organic/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
word	string	Ключевая фраза	true
url	string	Страница, представленная в выдаче `Cвязанный отчет: Органическая выдача - ключевые слова по странице`	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"ecco remote отзывы","url":"\/catalog\/464638\/detail.aspx","pos":1,"ws":33,"wsk":14,"docs":28000000,"avbid":166,"numwords":3,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Органическая выдача - cтраницы

GET `report/simple/organic/sitepages`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/simple/organic/sitepages?base=msk&domain=wildberries.ru&sort=it50%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
url	string	Адрес страницы сайта `Cвязанный отчет: Органическая выдача - ключевые слова по странице`	true
it1	integer	Запросов в топ 1	true
it3	integer	Запросов в топ 3	true
it5	integer	Запросов в топ 5	true
it10	integer	Запросов в топ 10	true
it50	integer	Запросов в топ 50	true
vis	integer	Оценка видимости страницы в поиске. Чем больше - тем больше потенциал трафика на страницу	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"url":"\/content\/size.html","it1":45,"it3":127,"it5":257,"it10":807,"it50":5321,"vis":22752}],"total":1}

Органическая выдача - ключевые слова по странице

GET `report/simple/organic/keywords/bypage`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
page_url	string	true	Url страницы `Доступен в отчетах "Органическая выдача - cтраницы", "Органическая выдача - запросы"`	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"талия 80 см какой размер","pos":1,"ws":63,"wsk":20,"docs":116000000,"avbid":199,"numwords":5,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Органическая выдача - конкуренты

GET `report/simple/organic/concurents`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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 `Cвязанный отчет: Сайты владельца`	false
analytics	integer	Идентификатор в Google Analytics `Cвязанный отчет: Сайты владельца`	false
relapio	string	Идентификатор вебмастера в Relap.io `Cвязанный отчет: Сайты владельца`	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 `Cвязанный отчет: Сайты владельца`	false
leadia	integer	Идентификатор вебмастера в Leadia `Cвязанный отчет: Сайты владельца`	false
leetero	integer	Идентификатор вебмастера в Leetero `Cвязанный отчет: Сайты владельца`	false

Пример ответа:

Органическая выдача - конкуренты страницы

GET `report/simple/organic/concurent_pages`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
domain	string	true	Имя домена	none
page_url	string	true	Url страницы `Доступен в отчетах "Органическая выдача - cтраницы", "Органическая выдача - запросы"`	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"did":29924580,"url":"\/shop\/producer\/6334\/sort\/a\/page\/1.html","domain":"my-shop.ru","cnt":80,"perc":64,"theme":80,"it1":0,"it3":0,"it5":0,"it10":4,"it50":125}],"total":1}

Ключевые слова - дополняющие фразы

GET `report/simple/similarkeys`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
base	string	true	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	none
keyword	string	true	поисковый запрос	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"как сделать ремонт на балконе","ws":573,"wsk":26,"cnt":68,"docs":100000000,"avbid":41}],"total":1}

Сайты владельца

GET `report/owner/{mode}`

Возможные значения {mode}:

analytics - поиск по идентификатору Google Analytics
adsense - поиск по идентификатору Google Adsense
leadia - поиск по идентификатору Leadia
moevideo - поиск по идентификатору Moevideo
leetero - поиск по идентификатору Leetero
relapio - поиск по идентификатору Relap.io
subdomains - поиск субдоменов по домену

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
id	string	true	В зависимости от {mode}: `analytics` - идентификатор Google Analytics `adsense` - идентификатор Google Adsense `leadia` - идентификатор Leadia `relapio` - идентификатор Relap.io `subdomains` - имя домена	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"name":"bepartner.wildberries.ru","it1":0,"it3":0,"it5":0,"it10":0,"it50":1,"pagesinindex":1,"adsenseid":"0","analytics":0,"relapio":"0","moevideo":0,"leadia":0,"leetero":0,"vis":0,"adscnt":0,"adkeyscnt":0,"adtraf":0,"adcost":0,"rsya":0}],"total":1}

Запросы сервиса (ключевые слова)

GET `report/keywords`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"бенеттон официальный сайт", "ws":17105,"wsk":11172,"docs":73000000, "numwords":3,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Описание REST API групповых отчеты

Создание отчета

POST `report/group`

Тело запроса:

Имя поля	Тип	Обязательный	Описание
base	String	true	Региональная база данных, по которой происходит выборка Возможные значения: `msk` - Я.Москва `spb` - Я.Санкт-Петербург `ekb` - Я.Екатеринбург `krr` - Я.Краснодар `nnv` - Я.Нижний Новгород `rnd` - Я.Ростов-на-Дону `yua` - Я.Киев `mns` - Я.Минск `kzn` - Я.Казань `gru` - G.Москва
domains	array	true	Массив доменов в отчете
name	String	false	Имя отчета

Пример запроса:

            {"base": "msk", "domains": ["mamsy.ru", "lamoda.ru", "quelle.ru", "bonprix.ru"]}

Структура ответа:

Имя поля	Тип	Описание
rid	string	Идентификатор отчета

Пример ответа:

            {"rid":"696b62ec6bceaf00529c4dd4bce02b47"}

Органическая выдача - ключевые слова группы

GET `report/group/organic/keywords/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"одежда для беременных интернет магазин недорогая","weight":4,"ws":2203,"wsk":975,"numwords":6,"isgeo":0,"isquest":0}],"total":1}

Органическая выдача - конкуренты группы

GET `report/group/organic/concurents/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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 `Cвязанный отчет: Сайты владельца`	false
analytics	integer	Идентификатор в Google Analytics `Cвязанный отчет: Сайты владельца`	false
relapio	string	Идентификатор вебмастера в Relap.io `Cвязанный отчет: Сайты владельца`	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 `Cвязанный отчет: Сайты владельца`	false
leadia	integer	Идентификатор вебмастера в Leadia `Cвязанный отчет: Сайты владельца`	false
leetero	integer	Идентификатор вебмастера в Leetero `Cвязанный отчет: Сайты владельца`	false

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"name":"wildberries.ru","perc":28,"cnt":479138,"it1":86990,"it3":302770,"it5":455279,"it10":742944,"it50":1683529,"pagesinindex":117711,"adsenseid":"0","analytics":0,"relapio":"0","vis":110373,"adscnt":16075,"adkeyscnt":732392,"adtraf":33507,"adcost":1110959,"rsya":0,"moevideo":0,"leadia":0,"leetero":0}],"total":1}

Органическая выдача - страницы группы

GET `report/group/organic/sitepages/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/group/organic/sitepages/696b62ec6bceaf00529c4dd4bce02b47?sort=vis%7Cdesc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
pid	integer	Идентификатор страницы `Cвязанный отчет: Простые отчеты - Органическая выдача - ключевые слова по странице`	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"pid":1424,"domain":"likewear.ru","url":"\/content\/size.html","it1":45,"it3":127,"it5":257,"it10":807,"it50":5321,"vis":22752}],"total":1}

Контекстная реклама - ключевые слова группы

GET `report/group/context/keywords/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"word":"длинные платья","weight":4,"ws":191654,"wsk":2289,"s0amn":12,"s0ctr":10.89,"gamn":8,"gctr":2.16,"numwords":2,"adscnt":8,"isgeo":0,"isquest":0}],"total":1}

Контекстная реклама - конкуренты группы

GET `report/group/context/concurents/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	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 `Cвязанный отчет: Сайты владельца`	false
analytics	integer	Идентификатор в Google Analytics `Cвязанный отчет: Сайты владельца`	false
relapio	string	Идентификатор вебмастера в Relap.io `Cвязанный отчет: Сайты владельца`	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 `Cвязанный отчет: Сайты владельца`	false
leadia	integer	Идентификатор вебмастера в Leadia `Cвязанный отчет: Сайты владельца`	false
leetero	integer	Идентификатор вебмастера в Leetero `Cвязанный отчет: Сайты владельца`	false

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"name":"wildberries.ru","perc":67,"cnt":488787,"it1":86990,"it3":302770,"it5":455279,"it10":742944,"it50":1683529,"pagesinindex":117711,"adsenseid":"0","analytics":0,"relapio":"0","vis":110373,"adscnt":16075,"adkeyscnt":732392,"adtraf":33507,"adcost":1110959,"rsya":0,"moevideo":0,"leadia":0,"leetero":0}],"total":1}

Контекстная реклама - объявления группы

GET `report/group/context/ads/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/group/context/ads/696b62ec6bceaf00529c4dd4bce02b47?sort=keyscnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
aid	integer	Идентификатор объявления `Cвязанный отчет: Простые отчеты - Контекстная реклама - ключевые слова по объявлению`	false
domain	string	Имя домена	true
header	string	Заголовок объявления	true
txt	string	Текст объявления	true
links	array	Массив быстрых ссылок	true
facts	array	Массив фактов	true
keyscnt	integer	Количество запросов	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"aid":9222,"domain":"likewear.ru","header":"Установки пластиковых окон в доме","txt":"Остекление домов от производителя. Гарантируем качество. Скидка 25%","links":["Калькулятор стоимости окна","Каталог профилей","Тёплое остекление"],"facts":["Собственное производство","Монтаж","Гарантия 5 лет"],"keyscnt":1}],"total":1}

Контекстная реклама - объявления, уникальные ссылки группы

GET `report/group/context/ads/links/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/group/context/ads/links/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
links	string	Уникальные ссылки	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"links":"Вечерние платья"}],"total":1}

Контекстная реклама - объявления, уникальные факты группы

GET `report/group/context/ads/facts/{rid}`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
rid	string	true	Идентификатор отчета	none
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `pos\|asc` Пример значения сортировки по двум полям: `pos\|asc,wsk\|desc`	none
filter	string	false	Подробнее про фильтрацию смотрите в разделе Описание API - Фильтрация данных	none

Пример запроса:

report/group/context/ads/facts/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25

Стандартная структура ответа:

Имя поля	Тип	Описание	Фильтр
links	string	Уникальные факты	true

Пример ответа:

            {"current_page":1,"per_page":25,"last_page":1,"data":[{"facts":"Более 10 лет на рынке"}],"total":1}

Описание REST API для запросов

Лимиты аккаунта

GET `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 - Установленный лимит для тарифа
maxSitesToCompare	object	Макс. сайтов в сравнении limit - int - Установленный лимит для тарифа

Пример ответа:

            {"analysis": {"limit": 100,"usedLimit": 0},"apiRequest": {"limit": 0,"usedLimit": 0},"users": {"limit": 1,"usedLimit": 0},"keysReportLimit": {"limit": 1000000},"recordsPerReport": {"limit": 50000},"maxSitesToCompare": {"limit": 5}}

Чистка неявных дублей

POST `tools/delete_double`

Тело запроса:

Имя поля	Тип	Обязательный	Описание
list	array	true	Массив фраз для чистки дублей

Пример запроса:

            {"list": ["одежда для беременных", "для беременных одежда", "одежда"]}

Структура ответа:

Имя поля	Тип	Описание
keys	array	Ключи
exclude	array	Ключи которые были исключены

Пример ответа:

            {"keys": ["одежда","одежда для беременных"],"exclude": ["для беременных одежда"]}

Расширение ключевых фраз - создание задания

POST `tools/extended_keywords`

Тело запроса:

Имя поля	Тип	Обязательный	Описание	Значение по умолчанию
list	array	true	Массив фраз	[]
config	object	false	Настройки similarity - int - похожесть (от 5 до 100, шаг 1) deleteDuplicate - bool - без повторов additions - bool - добавить "хвосты" исходных фраз	{"similarity": 30,"deleteDuplicate": true,"additions": false}
base	string	false	Региональная база данных, по которой происходит выборка Возможные значения: `zen` - Дзен `msk` - Яндекс: Москва `gru` - Google: Москва `spb` - Яндекс: Санкт-Петербург `ekb` - Яндекс: Екатеринбург `krr` - Яндекс: Краснодар `nnv` - Яндекс: Н. Новгород `rnd` - Яндекс: Ростов-на-Дону `gkv` - Google: Киев `mns` - Яндекс: Минск `gmns` - Google: Минск `kzn` - Яндекс: Казань `oms` - Яндекс: Омск `vlg` - Яндекс: Волгоград `nsk` - Яндекс: Новосибирск `che` - Яндекс: Челябинск `sam` - Яндекс: Самара `ufa` - Яндекс: Уфа `kry` - Яндекс: Красноярск `prm` - Яндекс: Пермь `vrn` - Яндекс: Воронеж `sar` - Яндекс: Саратов `gny` - Google: New York	msk

Пример запроса:

            {"list": ["купить пиццу", "купить две пиццы"],"config": {"similarity": 30,"deleteDuplicate": true,"additions": false},"base": "msk"}

Структура ответа:

Имя поля	Тип	Описание
uid	string	Идентификатор отчета

Пример ответа:

            {"uid": "7d9a401359df946e37cbebfc937a5d65"}

Расширение ключевых фраз - состояние отчета

GET `tools/extended_keywords/state/полученный UID`

Структура ответа:

Имя поля

Тип

Описание

state

int

Состояние:

0 - создан

1 - взят в обработку

10 - готов

progress

int

Прогресс в процентах (0 до 100)

Пример ответа:

            {"state": 10,"progress": 100}

Расширение ключевых фраз - получение результата

GET `tools/extended_keywords/полученный UID`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `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

Пример ответа:

            {"current_page": 1,"per_page": 25,"last_page": 1,"data": [{"source_key": "pizza","destination_key": "a pizza near me","frequency": 5000,"cnt": 36,"mincpc": 1,"maxcpc": 3,"numwords": 4,"adscnt": 0,"docs": 552000000}],"total": 1}

Массовая проверка запросов - создание задания

POST `tools/keywords_by_list`

Тело запроса:

Имя поля Тип Обязательный Описание Значение по умолчанию

list

array

true

Массив фраз

[]

base

string

false

Региональная база данных, по которой происходит выборка

Возможные значения:

zen - Дзен
msk - Яндекс: Москва
gru - Google: Москва
spb - Яндекс: Санкт-Петербург
ekb - Яндекс: Екатеринбург
krr - Яндекс: Краснодар
nnv - Яндекс: Н. Новгород
rnd - Яндекс: Ростов-на-Дону
gkv - Google: Киев
mns - Яндекс: Минск
gmns - Google: Минск
kzn - Яндекс: Казань
oms - Яндекс: Омск
vlg - Яндекс: Волгоград
nsk - Яндекс: Новосибирск
che - Яндекс: Челябинск
sam - Яндекс: Самара
ufa - Яндекс: Уфа
kry - Яндекс: Красноярск
prm - Яндекс: Пермь
vrn - Яндекс: Воронеж
sar - Яндекс: Саратов
gny - Google: New York

msk

Пример запроса:

            {"list": ["купить пиццу", "купить две пиццы"],"base": "msk"}

Структура ответа:

Имя поля	Тип	Описание
uid	string	Идентификатор отчета

Пример ответа:

            {"uid": "msk:44:6684baecf18566c4381fc7731925481"}

Массовая проверка запросов - получение результата

GET `tools/keywords_by_list/полученный UID`

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
Стандартные параметры запроса
page	integer	false	Порядковый номер страницы результатов	1
per_page	integer	false	Количество результатов на одной странице	50 000
sort	string	false	Сортировка данных по полям Формат: `field\|direction`, где `field` - имя колонки `direction` - направление сортировки, asc - по возрастанию, desc - по убыванию Пример значения: `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

Пример ответа:

            {"current_page": 1,"per_page": 25,"last_page": 1,"data": [{"word": "a pizza near me","frequency": 5000,"cnt": 36,"mincpc": 1,"maxcpc": 3,"numwords": 4,"adscnt": 0,"docs": 552000000, "serpf": "24.09.2022"}],"total": 1}

Кластеризация - создание задания

POST `/clustering`

Тело запроса:

Имя поля Тип Обязательный Описание Значение по умолчанию

list

array

true

Массив фраз

[]

base

string

false

Региональная база данных, по которой происходит выборка

Возможные значения:

zen - Дзен
msk - Яндекс: Москва
gru - Google: Москва
spb - Яндекс: Санкт-Петербург
ekb - Яндекс: Екатеринбург
krr - Яндекс: Краснодар
nnv - Яндекс: Н. Новгород
rnd - Яндекс: Ростов-на-Дону
gkv - Google: Киев
mns - Яндекс: Минск
gmns - Google: Минск
kzn - Яндекс: Казань
oms - Яндекс: Омск
vlg - Яндекс: Волгоград
nsk - Яндекс: Новосибирск
che - Яндекс: Челябинск
sam - Яндекс: Самара
ufa - Яндекс: Уфа
kry - Яндекс: Красноярск
prm - Яндекс: Пермь
vrn - Яндекс: Воронеж
sar - Яндекс: Саратов
gny - Google: New York

msk

Пример запроса:

            {"list": ["купить пиццу", "купить две пиццы"],"base": "msk"}

Структура ответа:

Имя поля	Тип	Описание
uid	string	Идентификатор отчета

Пример ответа:

            {"uid": "msk:44:6684baecf18566c4381fc7731925481"}

Кластеризация - запуск процесса

POST `/clustering/полученный UID/build`

Тело запроса:

Имя поля	Тип	Обязательный	Описание
topNumber	integer	true	Глубина проверки(топ 10, 20, 50)
fStrength	integer	false	более общее\мелкие группы(%)
fIsWsk	boolean	false	Минимальная [!частотность] главного ключа в группе(использовать или нет)
fWsk	integer	false	Минимальная [!частотность] главного ключа в группе(значение)
fIsSumWsk	boolean	false	Минимальная суммарная [!частотность] группы(использовать или нет)
fSumWsk	boolean	false	Минимальная суммарная [!частотность] группы(значение);

Пример запроса:

            {"topNumber": 10,"fStrength": 50,"fIsWsk": true,"fWsk": 100,"fIsSumWsk": true,"fSumWsk": 300}

Структура ответа:

Тип	Описание
boolean	Успешность постановки на кластеризацию

Пример ответа:

            true

Документация REST API сервиса Keys.so

Категории

Описание REST API сервиса

Описание REST API простых отчетов

GET report/simple/domain_dashboard

GET report/simple/keyword_dashboard

GET report/simple/context/keywords

GET report/simple/context/keywords/byads

GET report/simple/context/ads

GET report/simple/context/ads/links

GET report/simple/context/ads/facts

GET report/simple/context/concurents

GET report/simple/organic/keywords

GET report/simple/organic/sitepages

GET report/simple/organic/keywords/bypage

GET report/simple/organic/concurents

GET report/simple/organic/concurent_pages

GET report/simple/similarkeys

GET report/owner/{mode}

GET report/keywords

Описание REST API групповых отчеты

POST report/group

GET report/group/organic/keywords/{rid}

GET report/group/organic/concurents/{rid}

GET report/group/organic/sitepages/{rid}

GET report/group/context/keywords/{rid}

GET report/group/context/concurents/{rid}

GET report/group/context/ads/{rid}

GET report/group/context/ads/links/{rid}

GET report/group/context/ads/facts/{rid}

Описание REST API для запросов

GET limits/all

POST tools/delete_double

POST tools/extended_keywords

GET tools/extended_keywords/state/полученный UID

GET tools/extended_keywords/полученный UID

POST tools/keywords_by_list

GET tools/keywords_by_list/полученный UID

POST /clustering

POST /clustering/полученный UID/build

GET `report/simple/domain_dashboard`

GET `report/simple/keyword_dashboard`

GET `report/simple/context/keywords`

GET `report/simple/context/keywords/byads`

GET `report/simple/context/ads`

GET `report/simple/context/ads/links`

GET `report/simple/context/ads/facts`

GET `report/simple/context/concurents`

GET `report/simple/organic/keywords`

GET `report/simple/organic/sitepages`

GET `report/simple/organic/keywords/bypage`

GET `report/simple/organic/concurents`

GET `report/simple/organic/concurent_pages`

GET `report/simple/similarkeys`

GET `report/owner/{mode}`

GET `report/keywords`

POST `report/group`

GET `report/group/organic/keywords/{rid}`

GET `report/group/organic/concurents/{rid}`

GET `report/group/organic/sitepages/{rid}`

GET `report/group/context/keywords/{rid}`

GET `report/group/context/concurents/{rid}`

GET `report/group/context/ads/{rid}`

GET `report/group/context/ads/links/{rid}`

GET `report/group/context/ads/facts/{rid}`

GET `limits/all`

POST `tools/delete_double`

POST `tools/extended_keywords`

GET `tools/extended_keywords/state/полученный UID`

GET `tools/extended_keywords/полученный UID`

POST `tools/keywords_by_list`

GET `tools/keywords_by_list/полученный UID`

POST `/clustering`

POST `/clustering/полученный UID/build`