Keys.so API (1.0)
API интерфейс используется для того, чтобы интегрировать возможности сервиса Keys.so в личный проект клиента. API предназначен для разработчиков и сопровождается детальной документацией.
REST API сервиса работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.
Ограничения по запросам к API:
В данный момент - это 10 запросов в 10 секунд. Возможно послать 10 запросов в первую секунду, затем пауза в 10 секунд.
Процесс авторизации возможен при наличии персонального ключа (далее токен), которым в дальнейшем должен быть подписан каждый запрос к API.
Токен можно сформировать в настройках личного кабинета в блоке API.
Токен автоматически будет обновлен в случае смены пароля пользователя или по нажатию кнопки 'Сформировать новый токен'.
Большинство отчетов (если об этом не сказано отдельно) поддерживают стандартные параметры запроса:
| Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
current_page | integer | false | Порядковый номер страницы результатов | 1 |
per_page | integer | false | Количество результатов на одной странице | 25 |
sort | string | false | Сортировка данных по полям Формат:
Пример значения: pos|ascПример значения сортировки по двум полям: pos|asc,wsk|desc | none |
filter | string | false | Подробнее про фильтрацию смотрите в разделе Фильтрация данных | none |
Механизм фильтрации используется вместе с параметрами запроса по умолчанию.
Поля, которые поддерживают фильтрацию, перечислены в документации каждого отчета.
| Тип поля | Условие | Оператор, формат |
|---|---|---|
| string, integer | Строго равен | field=value |
| string, integer | Строго не равен | field!=value |
| string | Похож | fieldLIKEvalue |
| string | Не похож | fieldNOT LIKEvalue |
| string | Начинается с | fieldSTARTSWITHvalue |
| string | Заканчивается | fieldENDSWITHvalue |
| string, integer | Один из | fieldINvalueA, valueB |
| string, integer | Не один из | fieldNOT INvalueA, valueB |
| integer | Больше чем | field>value |
| integer | Меньше чем | field<value |
| integer | Больше или равно | field>=value |
| integer | Меньше или равно | field<=value |
| integer | Между | fieldBETWEENvalueA@valueB |
| string | Содержит | fieldREGEXPvalue |
| string | Не содержит | fieldNOT REGEXPvalue |
| integer | Содержит | fieldIN ARRAYvalue |
| integer | Не содержит | fieldNOT IN ARRAYvalue |
Примеры:
Формат фильтров:
<поле><оператор><значение>.
Операторы зависят от типа данных поля (строковые, числовые) и перечислены в таблице выше.
Простое условие (одно значение фильтра):
filter=weight>=1 Фильтрует записи, где значение поля weight больше или равно 1.
Комбинированные фильтры с использованием И (AND):
filter=weight>=1^ws>4
Фильтрует записи, где одновременно выполняются два условия: - Поле weight больше или равно 1. - Поле ws больше 4.
Комбинированные фильтры с использованием ИЛИ (OR):
filter=weight>=1^ORws>=2
Фильтрует записи, где выполняется хотя бы одно из условий: - Поле weight больше или равно 1. - Поле ws больше или равно 2.
Условия с исключением (НЕ / NOT):
filter=wordNOT LIKE видео
Исключает записи, где поле word содержит строку "видео".
Сложные фильтры с вложенными условиями:
filter=wordNOT LIKE видео^weight>=1^ORws>=3^avbid>=20
Фильтрует записи по следующим правилам:
- Исключает записи, где поле word содержит строку "видео".
- Одновременно выполняется одно из условий:
- Поле
weightбольше или равно 1. - Поле
wsбольше или равно 3. - Поле
avbidбольше или равно 20.
Информация о домене (Дашборд)
Пример запроса: https://api.keys.so/report/simple/domain_dashboard?base=msk&domain=wildberries.ru
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
Responses
Response samples
- 200
{- "id": 29918348,
- "name": "wildberries.ru",
- "parentid": 0,
- "parentName": "",
- "childsCount": 18,
- "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": "интернет магазин",
- "ws": 31497995,
- "wsk": 185018,
- "pos": 1
}
], - "concs": [
- {
- "did": 14791338,
- "name": "yandex.ru",
- "cnt": 1304735,
- "perc": 2.23,
- "vis": 9013545
}
], - "pages": [
- {
- "url": "/content/size.html",
- "it50": 5321
}
], - "ads": [
- {
- "id": 1424,
- "header": "Модные шапки - коллекция 2017 – Более 30000 моделей",
- "txt": "Скидки до 70% бесплатная курьерская доставка по России",
- "links": "Шапки для детей|Шапки для женщин|Шапки для мужчин",
- "facts": "string",
- "keyscnt": 5321
}
], - "adkeys": [
- {
- "word": "вайлдберриз",
- "ws": 499918,
- "wsk": 763146,
- "pos": 0,
- "avbid": 65,
- "p": [
- 0,
- 31
], - "sr": 0
}
], - "adconcs": [
- {
- "did": 14791338,
- "name": "lamoda.ru",
- "cnt": 436412,
- "adscnt": 44592,
- "adkeyscnt": 1099981,
- "vis": 3520115
}
], - "history": {
- "2023.01": [
- 84193,
- 1436310,
- 2503950,
- 4291083,
- 8481977,
- 998543,
- 37360,
- 491351,
- 1556892
]
}, - "linksHistory": {
- "2024.04": [
- 3979306,
- 72441715,
- 37555,
- 18,
- 11246
]
}
}Информация о ключевом слове (Дашборд)
Пример запроса: https://api.keys.so/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
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| keyword required | string Поисковый запрос |
Responses
Response samples
- 200
{- "id": 29918348,
- "word": "пластиковые окна",
- "ws": 31497995,
- "wsk": 185018,
- "isgeo": 0,
- "isquest": 0,
- "top": [
- {
- "did": 14791338,
- "delta": 0,
- "churl": 0,
- "pos": 1,
- "domain": "vekamoscow.ru",
- "url": "/windows-calc/",
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "pit1": 86990,
- "pit5": 455279,
- "pit10": 742944,
- "pit50": 1683529,
- "adsenseid": "0",
- "analytics": 65128131,
- "vis": 276
}
], - "ads": [
- {
- "did": 14791338,
- "bid": 5,
- "header": "Пластиковые окна КАЛЕВА! – Скидка 23%! От производителя!",
- "amn": 32,
- "txt": "Окна от производителя. Индикатор погоды METEOGLASS в подарок! Замер 0 руб. Звоните!",
- "facts": [
- "string"
], - "links": [
- "string"
], - "cpc_min": "0",
- "cpc_max": "0",
- "domain": "fabrikaokon.ru\""
}
], - "similar": [
- {
- "word": "пластиковые окна бесплатно",
- "kid": 31497995,
- "cnt": 31,
- "ws": 31497995,
- "wsk": 185018,
- "docs": 38000000,
- "avbid": 5
}
]
}Список групповых отчетов
Пример запроса https://api.keys.so/report/group/list?sort=access_date%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "rid": "3aa8f6a2603adc6fe499d42dcf82a4c8",
- "name": "asa1d",
- "base": "msk",
- "top": 10,
- "create_date": "2024-04-22 04:03:15",
- "access_date": "2024-04-22 04:03:27",
- "state": 10,
- "owner": "example@example.ru",
- "canDelete": true,
- "canChangeOwner": true
}
]
}Создание отчета
Создание отчета и получение идентификатора, который понадобится в дальнейшем для взаимодействия с отчетом.
Authorizations:
Request Body schema: application/jsonrequired
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| top | integer Default: 10 Enum: 10 50 Охват позиций |
| domains required | Array of strings Массив доменов в отчете |
| name | any Имя отчета |
Responses
Request samples
- Payload
{- "base": "msk",
- "top": 10,
- "domains": [
- [
- "keys.so",
- "dodopizza.ru"
]
], - "name": null
}Response samples
- 200
{- "rid": "696b62ec6bceaf00529c4dd4bce02b47"
}Домены в отчете
Пример запроса https://api.keys.so/report/group/domains/3aa8f62903adc6fe499d42dcf82a4c8?sort=it50%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": "dodopizza.ru",
- "name": "dodopizza.ru",
- "path": "/",
- "it1": 86990,
- "it3": 302770,
- "it5": 45527,
- "it10": 742944,
- "it50": 1683529,
- "pagesinindex": 117711,
- "vis": 110373,
- "adscnt": 16075,
- "adkeyscnt": 732392,
- "adtraf": 33507,
- "adcost": 1110959
}
]
}Органическая выдача - ключевые слова группы
Пример запроса https://api.keys.so/report/group/organic/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 31497995,
- "avbid": 5,
- "word": "одежда для беременных интернет магазин недорогая",
- "weight": 4,
- "ws": 31497995,
- "wsk": 185018,
- "numwords": 6,
- "isgeo": 6,
- "isquest": 6
}
]
}Органическая выдача - конкуренты группы
Пример запроса https://api.keys.so/report/group/organic/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 31497995,
- "name": "wildberries.ru",
- "perc": 28.1,
- "cnt": 479138,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "pagesinindex": 117711,
- "vis": 110373,
- "adscnt": 16075,
- "adkeyscnt": 732392,
- "adtraf": 33507,
- "adcost": 1110959
}
]
}Органическая выдача - страницы группы
Пример запроса https://api.keys.so/report/group/organic/sitepages/696b62ec6bceaf00529c4dd4bce02b47?sort=vis%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "domain": "likewear.ru",
- "url": "/content/size.html",
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "vis": 110373
}
]
}Контекстная реклама - ключевые слова группы
Пример запроса https://api.keys.so/report/group/context/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=weight%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 31497995,
- "weight": 4,
- "ws": 191654,
- "wsk": 2289,
- "numwords": 2,
- "isgeo": 0,
- "isquest": 0,
- "avbid": 5
}
]
}Контекстная реклама - конкуренты группы
Пример запроса https://api.keys.so/report/group/context/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 31497995,
- "name": "wildberries.ru",
- "perc": 28.1,
- "cnt": 479138,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "pagesinindex": 117711,
- "vis": 110373,
- "adscnt": 16075,
- "adkeyscnt": 732392,
- "adtraf": 33507,
- "adcost": 1110959
}
]
}Контекстная реклама - объявления группы
Пример запроса https://api.keys.so/report/group/context/ads/696b62ec6bceaf00529c4dd4bce02b47?sort=keyscnt%7Casc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "aid": 234121,
- "domain": "okna-home.com",
- "header": "Пластиковые окна КАЛЕВА! – Скидка 23%! От производителя!",
- "txt": "Окна от производителя. Индикатор погоды METEOGLASS в подарок! Замер 0 руб. Звоните!",
- "links": [
- "string"
], - "facts": [
- "string"
], - "keyscnt": 1
}
]
}Контекстная реклама - объявления, уникальные ссылки группы
Пример запроса https://api.keys.so/report/group/context/ads/links/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "links": "Вечерние платья"
}
]
}Контекстная реклама - объявления, уникальные факты группы
Пример запроса https://api.keys.so/report/group/context/ads/facts/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25
Authorizations:
path Parameters
| rid required | string Идентификатор отчёта |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "facts": "Более 10 лет на рынке"
}
]
}Органическая выдача - конкуренты
Пример запроса https://api.keys.so/report/simple/organic/concurents?base=msk&domain=wildberries.ru&top=10&sort=cnt%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
| top | integer Default: 10 Enum: 10 50 Охват позиций |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 14791338,
- "name": "wildberries.ru",
- "perc": 28.1,
- "theme": 34.7,
- "cnt": 479138,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "pagesinindex": 117711,
- "vis": 110373,
- "adscnt": 16075,
- "adkeyscnt": 732392,
- "adtraf": 33507,
- "adcost": 1110959
}
]
}Органическая выдача - конкуренты страницы
Пример запроса https://api.keys.so/report/simple/organic/concurent_pages?base=msk&domain=wildberries.ru&page_url=%2Fbrands%2Fadidas&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page_url required | string Url страницы |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "did": 14791338,
- "domain": "wildberries.ru",
- "url": "/shop/producer/6334/sort/a/page/1.htm",
- "perc": 28.1,
- "theme": 34.7,
- "cnt": 479138,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529
}
]
}Органическая выдача - cтраницы
Пример запроса https://api.keys.so/report/simple/organic/sitepages?base=msk&domain=wildberries.ru&sort=it50%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "url": "/content/size.html",
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "vis": 110373,
- "new_url": 0,
- "found_date": "11.06.2023"
}
]
}Органическая выдача - ключевые слова
Пример запроса https://api.keys.so/report/simple/organic/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
| url | string Example: url=/ URL |
| includeSubLevels | integer Example: includeSubLevels=1 Включить подуровни |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "ecco remote отзывы",
- "url": "/catalog/464638/detail.aspx",
- "ws": 14791338,
- "wsk": 86990,
- "pos": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "nw": 0,
- "delta": 0,
- "churl": 0,
- "wizardscount": 0,
- "wizards": {
- "43": "карта"
}, - "kid": 572850182,
- "did": 261720522,
- "serpf": "10.06.2024"
}
]
}Органическая выдача - ключевые слова по странице
Пример запроса https://api.keys.so/report/simple/organic/keywords/bypage?base=msk&domain=wildberries.ru&page_url=%2Fbrands%2Fadidas&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page_url required | string Url страницы |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "бенеттон официальный сайт",
- "ws": 14791338,
- "wsk": 86990,
- "pos": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "nw": 0,
- "delta": 0,
- "churl": 0,
- "wizardscount": 0,
- "wizards": {
- "43": "карта"
}, - "kid": 572850182,
- "did": 30069294,
- "serpf": "10.06.2024"
}
]
}Органическая выдача - Запросы сайта
Пример запроса https://api.keys.so/report/simple/organic/sitepages/withkeys?base=msk&domain=dodopizza.ru&sort=url%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "ecco remote отзывы",
- "url": "/catalog/464638/detail.aspx",
- "ws": 14791338,
- "wsk": 86990,
- "pos": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "vis": 110373,
- "superwsk": 32765856
}
]
}Органическая выдача - Потерянные запросы
Пример запроса https://api.keys.so/report/simple/organic/lost_keywords?base=msk&domain=dodopizza.ru&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "ecco remote отзывы",
- "url": "/catalog/464638/detail.aspx",
- "ws": 14791338,
- "wsk": 86990,
- "pos": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "superwsk": 32765856,
- "kid": 572850182,
- "did": 261720522,
- "serpf": "10.06.2024"
}
]
}Органическая выдача - Потерянные страницы
Пример запроса https://api.keys.so/report/simple/organic/lost_pages?base=msk&domain=dodopizza.ru&sort=it50%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "url": "/catalog/464638/detail.aspx",
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "vis": 110373,
- "drop_date": "01.06.2024"
}
]
}Контекстная реклама - конкуренты
Пример запроса https://api.keys.so/report/simple/context/concurents?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 14791338,
- "name": "wildberries.ru",
- "perc": 28.1,
- "theme": 34.7,
- "cnt": 479138,
- "it1": 86990,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "pagesinindex": 117711,
- "vis": 110373,
- "adscnt": 16075,
- "adkeyscnt": 732392,
- "adtraf": 33507,
- "adcost": 11109590
}
]
}Контекстная реклама - ключевые слова по объявлению
Пример запроса https://api.keys.so/report/simple/context/keywords/byads?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| ads_id required | string Идентификатор объявления |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "бенеттон официальный сайт",
- "header": "",
- "txt": "",
- "ws": 14791338,
- "wsk": 86990,
- "superwsk": 32765856,
- "pos": 0,
- "sr": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "serp": "10.06.2024"
}
]
}Контекстная реклама - ключевые слова
Пример запроса https://api.keys.so/report/simple/context/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 31497995,
- "aid": 31497995,
- "word": "бенеттон официальный сайт",
- "header": "",
- "txt": "",
- "ws": 14791338,
- "wsk": 86990,
- "pos": 0,
- "sr": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "serpf": "10.06.2024"
}
]
}Контекстная реклама - объявления
Пример запроса https://api.keys.so/report/simple/context/ads?base=msk&domain=wildberries.ru&sort=keyscnt%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| full | boolean Default: false Если |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 234121,
- "header": "Пластиковые окна КАЛЕВА! – Скидка 23%! От производителя!",
- "txt": "Окна от производителя. Индикатор погоды METEOGLASS в подарок! Замер 0 руб. Звоните!",
- "links": [
- "string"
], - "facts": [
- "string"
], - "keyscnt": 1,
- "keys": [
- "стоимость установки пластиковых окон в деревянном доме"
], - "legal": "ООО ЛЕОВИТ нутрио, ИНН 7713204095, ID 77154557",
- "serp": "10.06.2024"
}
]
}Контекстная реклама - объявления, уникальные ссылки
Пример запроса https://api.keys.so/report/simple/context/ads/links?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "links": [
- "string"
]
}
]
}Контекстная реклама - объявления, уникальные факты
Пример запроса https://api.keys.so/report/simple/context/ads/facts?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "facts": [
- "string"
]
}
]
}Запросы сервиса
Пример запроса https://api.keys.so/report/system_keywords?strict=true&base=msk&hideadult=true
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| strict required | boolean Default: true Нечеткий поиск(поддержка склонения слов, изменения их порядка, не более 1 000 000 результатов) |
| hideadult required | boolean Default: true Скрыть запросы тематики 18+ |
| page | integer Default: 1 Порядковый номер страницы результатов |
| sort | string Сортировка данных по полям. |
Request Body schema: application/json
object Параметры запроса в теле |
Responses
Request samples
- Payload
{- "params": {
- "filter": "string",
- "per_page": 25,
- "page": 1,
- "sort": "string"
}
}Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "superwsk": 32765856,
- "ws": 14791338,
- "wsk": 86990,
- "docs": 732392,
- "numwords": 1,
- "word": "ютуб",
- "updated_at": "26.05.2024",
- "isgeo": 0,
- "isquest": 0,
- "isadult": 0,
- "gctr": 0,
- "gamn": 0,
- "avbid": 0
}
]
}Дополняющие фразы
Пример запроса https://api.keys.so/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
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| keyword required | string Поисковый запрос |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "как сделать ремонт на балконе",
- "cnt": 68,
- "ws": 14791338,
- "wsk": 86990,
- "docs": 732392,
- "avbid": 5,
- "numwords": 5,
- "adscnt": 16075,
- "isgeo": 0,
- "isquest": 0,
- "wizardscount": 0,
- "wizards": {
- "43": "карта"
}, - "serpf": "10.06.2024",
- "kei": 0
}
]
}Чистка неявных дублей
Authorizations:
Request Body schema: application/jsonrequired
| list required | Array of arrays Массив фраз для чистки дублей |
Responses
Request samples
- Payload
{- "list": [
- "одежда для беременных",
- "для беременных одежда",
- "одежда"
]
}Response samples
- 200
{- "keys": [
- [
- "одежда",
- "одежда для беременных"
]
], - "exclude": [
- [
- "для беременных одежда"
]
]
}Расширение ключевых фраз - создание задания
Authorizations:
Request Body schema: application/jsonrequired
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| list required | Array of strings Массив фраз |
object Default: {"similarity":30,"deleteDuplicate":true,"additions":false} Массив фраз |
Responses
Request samples
- Payload
{- "base": "msk",
- "list": [
- "одежда для беременных",
- "для беременных одежда",
- "одежда"
], - "config": {
- "similarity": 30,
- "deleteDuplicate": true,
- "additions": false
}
}Response samples
- 200
{- "uid": "7d9a401359df946e37cbebfc937a5d65"
}Расширение ключевых фраз - состояние отчета
Пример запроса https://api.keys.so/tools/extended_keywords/state/7d9a401359df946e37cbebfc937a5d65 полученный в Расширение ключевых фраз - создание задания
Authorizations:
path Parameters
| uid required | string Идентификатор отчета |
Responses
Response samples
- 200
{- "state": 10,
- "progress": 100
}Расширение ключевых фраз - получение результата
Пример запроса https://api.keys.so/tools/extended_keywords/7d9a401359df946e37cbebfc937a5d65?sort=wsk%7Casc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчета |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "source_key": "pizza",
- "destination_key": "a pizza near me",
- "ws": 14791338,
- "wsk": 86990,
- "frequency": 0,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "addition": false,
- "cnt": 12,
- "maxcpc": 12,
- "mincpc": 12
}
]
}Массовая проверка запросов - создание задания
Authorizations:
Request Body schema: application/jsonrequired
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| list required | Array of arrays Массив фраз |
Responses
Request samples
- Payload
{- "base": "msk",
- "list": [
- "одежда для беременных",
- "для беременных одежда",
- "одежда"
]
}Response samples
- 200
{- "uid": "6684baecf18566c4381fc7731925481"
}Массовая проверка запросов - получение результата
Пример запроса https://api.keys.so/tools/keywords_by_list/msk:44:6684baecf18566c4381fc7731925481d?base=msk&sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчета |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "word": "pizza",
- "ws": 14791338,
- "wsk": 86990,
- "numwords": 5,
- "adscnt": 16075,
- "docs": 732392,
- "avbid": 5,
- "isgeo": 0,
- "isquest": 0,
- "serpf": "24.09.2022"
}
]
}История выдачи SERP по запросу
Пример запроса https://api.keys.so/tools/history-serp?base=gru
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
| keyword required | string Поисковая фраза |
Responses
Request samples
- Payload
{- "keyword": "купить телефон"
}Response samples
- 200
{- "<YYYY.MM>": {
- "did": 261720522,
- "domain": "notisend.ru",
- "pos": 0,
- "url": "/catalog/464638/detail.aspx"
}
}Подсветка топов
Пример запроса https://api.keys.so/tools/check-top?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
| list required | Array of strings Список поисковых фраз |
Responses
Request samples
- Payload
{- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
]
}Response samples
- 200
{- "<keyword>": [
- {
- "count": {
- "domain": 0,
- "url": 0
}, - "domain": "testometrika.com",
- "pos": 1,
- "url": "testometrika.com\\/tests"
}
]
}Подсветка топов - сайты конкурентов
Пример запроса https://api.keys.so/tools/check-top-concurents-domains?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
| list required | Array of strings Список поисковых фраз |
| page | integer Текущая страница |
| perPage | integer Записей на странице |
Responses
Request samples
- Payload
{- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "page": 1,
- "perPage": 25
}Response samples
- 200
{- "total": 150,
- "data": [
- {
- "cnt": 5,
- "did": 29918164,
- "name": "yandex.ru"
}
]
}Подсветка топов - страницы конкурентов
Пример запроса https://api.keys.so/tools/check-top-concurents-urls?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
| list required | Array of strings Список поисковых фраз |
| page | integer Текущая страница |
| perPage | integer Записей на странице |
Responses
Request samples
- Payload
{- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "page": 1,
- "perPage": 25
}Response samples
- 200
{- "total": 150,
- "data": [
- {
- "cnt": 5,
- "did": 29918164,
- "fullUrl": "pikabu.ru/story/6_poiskovikov_kotoryie_luchshe_chem_google_4228012",
- "name": "yandex.ru",
- "url": "/story/6_poiskovikov_kotoryie_luchshe_chem_google_4228012"
}
]
}Сравнение списков ключевых фраз
Пример запроса https://api.keys.so/tools/compare
Authorizations:
Request Body schema: application/json
| left required | Array of strings Список поисковых фраз |
| right required | Array of strings Список поисковых фраз |
| options required | string Enum: "present_right" "uniq" "union" "present_left" Тип сравнения |
Responses
Request samples
- Payload
{- "left": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "right": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "options": "present_right"
}Response samples
- 200
[- "заключение от фтизиатра",
- "фтизиатр после пробы манту"
]Комбинатор ключевых фраз
Пример запроса https://api.keys.so/tools/combine
Authorizations:
Request Body schema: application/json
| lists required | Array of arrays Список поисковых фраз |
| options | Array of strings Дополнительные настройки: |
Responses
Request samples
- Payload
{- "lists": {
- "0": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "1": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "2": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
]
}, - "options": [
- "quotes",
- "brackets",
- "simple",
- "stop_word"
]
}Response samples
- 200
"string"Выделение уникальных слов в тексте
Пример запроса https://api.keys.so/tools/unique
Authorizations:
Request Body schema: application/json
| list required | Array of strings Список поисковых фраз |
Responses
Request samples
- Payload
{- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
]
}Response samples
- 200
{- "count": 18,
- "open": false,
- "keys": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "words": [
- "фтизиатра",
- "фтизиатру",
- "фтизиатр"
]
}Сбор поисковых подсказок в Яндексе
Пример запроса https://api.keys.so/tools/suggest
Authorizations:
Request Body schema: application/json
| list required | Array of strings Список исходных ключевых слов |
| region required | integer Enum: 1 2 4 5 7 8 9 10 11 12 13 14 15 16 20 21 22 23 24 25 28 30 33 35 36 37 38 39 41 42 43 45 47 48 49 50 51 53 54 56 62 63 64 65 66 67 75 76 77 149 159 172 187 191 192 193 195 197 213 225 239 973 1092 1104 1106 Код региона: |
Responses
Request samples
- Payload
{- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
], - "region": 1
}Response samples
- 200
Входящие ссылки
Пример запроса https://api.keys.so/report/simple/links/backlinks?domain=wildberries.ru&sort=created_at%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "anchor": "ИЦК-121 Кроссовки мужские",
- "created_at": "26.05.2024",
- "domain_exist": true,
- "id": 261720522,
- "link_type": 1,
- "rel_type": [
- 1
], - "source_did": 302456420,
- "source_dr": 0,
- "source_ip": "198.54.121.233",
- "source_name": "trmorning.com",
- "source_title": "Portfolio Nine - My Portfolio Blog",
- "status": 0,
- "updated_at": "26.05.2024"
}
]
}Исходящие ссылки
Пример запроса https://api.keys.so/report/simple/links/outlinks?domain=wildberries.ru&sort=created_at%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "anchor": "ИЦК-121 Кроссовки мужские",
- "created_at": "26.05.2024",
- "domain_exist": true,
- "did": 261720522,
- "id": 343254837,
- "link_type": 1,
- "rel_type": [
- 1
], - "dr": 0,
- "name": "trmorning.com",
- "status": 0,
- "updated_at": "26.05.2024"
}
]
}Ссылающиеся домены
Пример запроса https://api.keys.so/report/simple/links/backlinks-domains?domain=wildberries.ru&sort=outlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 343254837,
- "rel_type": [
- 1,
- 2,
- 0
], - "dr": 67,
- "outlinks_count": 533737599,
- "outlinks_active_count": 300000000,
- "outlinks_archive_count": 233737599,
- "name": "trmorning.com",
- "ips": 210301,
- "total_backdomains_count": 1973265,
- "total_outdomains_count": 472156,
- "vis": 6111921
}
]
}Ссылающиеся домены c данными по конкретному домену
Пример запроса https://api.keys.so/report/simple/links/backlinks-domains?domain=wildberries.ru&view=domain&sort=outlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| view required | string Example: view=domain Фильтр данных по конкретному домену |
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "view": "domain",
- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 343254837,
- "rel_type": [
- 1,
- 2,
- 0
], - "dr": 67,
- "outlinks_count": 533737599,
- "outlinks_active_count": 300000000,
- "outlinks_archive_count": 233737599,
- "name": "trmorning.com",
- "vis": 6111921
}
]
}Исходящие домены
Пример запроса https://api.keys.so/report/simple/links/outlinks-domains?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "did": 261720522,
- "id": 343254837,
- "rel_type": [
- 1,
- 2,
- 0
], - "dr": 67,
- "backlinks_count": 66518846,
- "backlinks_active_count": 20000000,
- "backlinks_archive_count": 46518846,
- "name": "trmorning.com",
- "ips": 210301,
- "total_backdomains_count": 1973265,
- "total_outdomains_count": 472156,
- "vis": 6111921,
- "statuses": [
- 1,
- 10
]
}
]
}Исходящие домены c данными по конкретному домену
Пример запроса https://api.keys.so/report/simple/links/outlinks-domains?domain=wildberries.ru&view=domain&sort=backlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| view required | string Example: view=domain Фильтр данных по конкретному домену |
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "view": "domain",
- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "did": 261720522,
- "id": 343254837,
- "rel_type": [
- 1,
- 2,
- 0
], - "dr": 67,
- "backlinks_count": 66518846,
- "backlinks_active_count": 20000000,
- "backlinks_archive_count": 46518846,
- "name": "trmorning.com",
- "ips": 210301,
- "total_backdomains_count": 1973265,
- "total_outdomains_count": 472156,
- "vis": 6111921,
- "statuses": [
- 1,
- 10
]
}
]
}Ссылки по IP
Пример запроса https://api.keys.so/report/simple/links/backlinks-ip?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "backlinks_count": 261720522,
- "domains_count": 154,
- "domains": [
- "msk.compumir.ru",
- "965059"
], - "source_ip": "94.198.51.98"
}
]
}Ссылки по IP - подсети
Пример запроса https://api.keys.so/report/simple/links/backlinks-ip/subnet?domain=wildberries.ru&sort=domains_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "backlinks_count": 261720522,
- "domains_count": 154,
- "ips_count": 60,
- "subnet": "185.215.4.*"
}
]
}Анкоры
Пример запроса https://api.keys.so/report/simple/links/backlinks-anchor?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "anchor": "Подробнее...",
- "backlinks_count": 343254837,
- "rel_type": [
- 1,
- 2,
- 0
], - "link_type": 1,
- "words_count": 1,
- "statuses": [
- 1,
- 10
]
}
]
}Популярные страницы
Пример запроса https://api.keys.so/report/simple/links/pages?domain=dodopizza.ru&sort=numurl%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
]
}Кластеризация - создание задания
Authorizations:
Request Body schema: application/json
| list required | Array of strings Массив фраз |
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Responses
Request samples
- Payload
{- "list": [
- "одежда для беременных",
- "для беременных одежда",
- "одежда"
], - "base": "msk"
}Response samples
- 200
{- "uid": "msk:44:6684baecf18566c4381fc7731925481"
}Список проектов кластеризатора
Пример запроса https://api.keys.so/clustering/list?sort=access_date%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| isMain | boolean Default: false Example: isMain=true Список проектов: |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "access_date": "2024-04-22 04:03:27",
- "base": "msk",
- "canChangeOwner": true,
- "canDelete": true,
- "child_projects": {
- "serp": [
- {
- "id": 6178,
- "name": "keys.so - monitoring - Волгоград"
}
], - "wordstat": [
- {
- "id": 37941,
- "name": "keys.so - monitoring - Волгоград"
}
]
}, - "create_date": "2024-04-22 04:03:15",
- "monitoring_id": 0,
- "monitoring_name": "keys.so",
- "name": "qwerty",
- "owner": "example@example.ru",
- "state": 10,
- "uid": "94e99ef90a8fa62000227d5bc122e5c42123"
}
]
}Кластеризация - запуск процесса
Запуск процесса. Вместо UID в уре запроса, идентификатор полученный при создании.
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Request Body schema: application/jsonrequired
| topNumber | integer Глубина проверки(топ 10, 20, 50) |
| fStrength | integer Более общее\мелкие группы(%) |
| fIsWsk | boolean Минимальная [!частотность] главного ключа в группе(использовать или нет) |
| fWsk | integer Минимальная [!частотность] главного ключа в группе(значение) |
| fIsSumWsk | boolean Минимальная суммарная [!частотность] группы(использовать или нет) |
| fSumWsk | boolean Минимальная суммарная [!частотность] группы(значение) |
Responses
Request samples
- Payload
{- "topNumber": 10,
- "fStrength": 50,
- "fIsWsk": true,
- "fWsk": 100,
- "fIsSumWsk": true,
- "fSumWsk": true
}Response samples
- 200
trueПолучение папок кластеризации
Пример запроса https://api.keys.so/clustering/node/59f2bо9004be5449891467f07a4eb5a9
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Responses
Response samples
- 200
{- "0": {
- "id": 0,
- "pid": -10,
- "name": "Все узлы",
- "keys_count": 0,
- "max_key_wsk": 0,
- "max_key_superwsk": 0,
- "max_key_ws": 0,
- "ws_sum": 0,
- "wsk_sum": 0,
- "superwsk_sum": 0,
- "lock": false,
- "children": [
- {
- "id": -1,
- "pid": 0,
- "name": "Нераспределенные",
- "lock": true,
- "keys_count": 90,
- "ws_sum": 0,
- "wsk_sum": 0,
- "superwsk_sum": 0,
- "max_key_ws": 0,
- "max_key_wsk": 0,
- "max_key_superwsk": 0,
- "children": [ ]
}
]
}
}Результат кластеризации, ключи в папке
Пример запроса https://api.keys.so/clustering/node/59f2b99604be5449891467f07a4eb5a7/46984224/keywords?sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
| id required | string Идентификатор папки |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 1089273244,
- "adscnt": 16075,
- "isgeo": 0,
- "isquest": 0,
- "master_key": 1,
- "numwords": 4,
- "word": "создать игру на андроид",
- "ws": 1479,
- "wsk": 869
}
]
}Создание проекта
Пример запроса https://api.keys.so/projects
Authorizations:
Request Body schema: application/json
| domain required | string Адрес сайта |
| name | string Название проекта |
| competitors | Array of strings Конкуренты |
Responses
Request samples
- Payload
{- "domain": "notisend.ru",
- "name": "notisend.ru",
- "competitors": [
- "senler.ru",
- "sigmasms.ru",
- "smsdar.ru",
- "smspobeda.ru",
- "bandlink.media"
]
}Response samples
- 200
[ ]Response samples
- 200
[- {
- "projectId": 51565,
- "title": "notisend.ru",
- "domain": {
- "did": 30457180,
- "name": "notisend.ru",
- "main": true
}, - "competitors": [
- {
- "did": 77679802,
- "name": "senler.ru",
- "main": false
}
], - "settings": {
- "chartSettings": {
- "vis": true,
- "it50": true,
- "it10": true,
- "it3": true,
- "pagesInIndex": true,
- "adTraf": true,
- "adKeysCount": true,
- "adsCount": true,
- "adCost": true,
- "rsyAdsCount": true,
- "backlinksCount": true,
- "outlinksCount": true,
- "uniqBackdomainsCount": true,
- "uniqBackipsCount": true,
- "dr": true
}, - "notificationSettings": {
- "organic": true,
- "context": false,
- "links": true,
- "databases": {
- "msk": true,
- "gru": true
}
}, - "isDemo": false
}, - "extSettings": {
- "notifications": {
- "isNotifyMuted": false,
- "periodicity": 1,
- "notifyEmail": true,
- "notifyTelegram": false
}
}, - "periodicityData": {
- "1": "При изменении",
- "2": "Раз в 14 дней",
- "3": "Раз в месяц"
}, - "hidden": false,
- "exist": true,
- "isFree": false,
- "lastNotifyData": {
- "msk": [
- {
- "organic": {
- "vis": {
- "value": 18,
- "delta": -1
}, - "it50": {
- "value": 324,
- "delta": 14
}, - "it10": {
- "value": 45,
- "delta": 2
}, - "it3": {
- "value": 18,
- "delta": -2
}, - "pagesInIndex": {
- "value": 21,
- "delta": 0
}
}, - "context": {
- "adTraf": {
- "value": 1,
- "delta": 0
}, - "adKeysCount": {
- "value": 83,
- "delta": 14
}, - "adsCount": {
- "value": 18,
- "delta": 3
}, - "adCost": {
- "value": 6333,
- "delta": -11867
}, - "rsyAdsCount": {
- "value": 1,
- "delta": -1
}
}
}
], - "gru": [
- {
- "organic": {
- "vis": {
- "value": 19,
- "delta": -3
}, - "it50": {
- "value": 530,
- "delta": 0
}, - "it10": {
- "value": 78,
- "delta": -1
}, - "it3": {
- "value": 28,
- "delta": 0
}, - "pagesInIndex": {
- "value": 46,
- "delta": 1
}
}, - "context": {
- "adTraf": {
- "value": 0,
- "delta": 0
}, - "adKeysCount": {
- "value": 0,
- "delta": 0
}, - "adsCount": {
- "value": 0,
- "delta": 0
}, - "adCost": {
- "value": 0,
- "delta": 0
}, - "rsyAdsCount": {
- "value": 0,
- "delta": 0
}
}
}
], - "link": [
- {
- "drmsk": {
- "value": 20,
- "delta": -2
}, - "drgru": {
- "value": 20,
- "delta": -4
}, - "backlinksCount": {
- "value": 3278,
- "delta": 135
}, - "outlinksCount": {
- "value": 469,
- "delta": 20
}, - "uniqBackdomainsCount": {
- "value": 143,
- "delta": 0
}, - "uniqBackipsCount": {
- "value": 114,
- "delta": 0
}
}
]
}, - "type": 1,
- "colors": {
- "vis": "#4DC9F6",
- "it50": "#F67019",
- "it10": "#DC2B2B",
- "it3": "#B6E302",
- "pagesInIndex": "#F53794",
- "dr": "#537BC4",
- "adTraf": "#ACC236",
- "adKeysCount": "#00A950",
- "adsCount": "#58595B",
- "rsyAdsCount": "#8549BA",
- "adCost": "cyan",
- "backlinksCount": "red",
- "outlinksCount": "violet",
- "uniqBackdomainsCount": "lightcoral",
- "uniqBackipsCount": "darkred"
}, - "gData": {
- "<YYYY.MM>": {
- "vis": 1,
- "it50": 352,
- "it10": 7,
- "it3": 1,
- "pagesInIndex": 18,
- "adTraf": 2,
- "adKeysCount": 485,
- "adsCount": 21,
- "adCost": 796308,
- "dr": 0,
- "rsyAdsCount": 0,
- "backlinksCount": 0,
- "outlinksCount": 0,
- "uniqBackdomainsCount": 0,
- "uniqBackipsCount": 0
}
}, - "data": [
- {
- "<index>": {
- "type": "organic",
- "name": "vis",
- "value": 18,
- "delta": -1,
- "link": "/ru/report?domain=notisend.ru"
}
}
], - "hideItems": [ ],
- "position": 4
}
]
Удаление проекта
Пример запроса https://api.keys.so/projects/delete
Authorizations:
Request Body schema: application/json
| projectId required | integer Идентификатор проекта |
Responses
Request samples
- Payload
{- "projectId": 3134
}Response samples
- 200
[ ]Рекомендуемые конкуренты
Пример запроса /projects/recommended-competitors?domain=notisend.ru
Authorizations:
query Parameters
| domain required | string Имя домена |
Responses
Response samples
- 200
[- "senler.ru",
- "sigmasms.ru",
- "smsdar.ru",
- "smspobeda.ru",
- "bandlink.media"
]Сравнение с конкурентами
Пример запроса https://api.keys.so/projects/competitors?projectId=12333
Authorizations:
query Parameters
| projectId | integer Example: projectId=12333 Идентификатор проекта |
Responses
Response samples
- 200
[- {
- "<property>": {
- "checked": {
- "30457180": false,
- "77679802": false
}, - "colors": {
- "30457180": "#4DC9F6",
- "77679802": "#F67019"
}, - "domains": [
- {
- "did": 77679802,
- "name": "senler.ru",
- "main": false
}
], - "gData": {
- "<domainID>": {
- "2016.1": 40141,
- "2016.12": 497,
- "2017.01": 0
}
}, - "links": {
- "<domainID>": {
- "30457180": "/ru/report?domain=notisend.ru"
}
}, - "name": "adCost",
- "showProperty": true,
- "views": [
- "organic",
- "context"
], - "xAxis": [
- 2024.04,
- 2024.05,
- 2024.06
]
}
}
]Сравнение с конкурентами(диаграмма)
Пример запроса https://api.keys.so/projects/competitors/compare
Authorizations:
Request Body schema: application/json
| view required | string Enum: "organic" "context" Отчет вернет результаты для органики( |
| domains required | Array of strings Конкуренты |
| type | integer Deprecated |
Responses
Request samples
- Payload
{- "view": "organic",
- "domains": [
- "senler.ru",
- "sigmasms.ru",
- "smsdar.ru",
- "smspobeda.ru",
- "bandlink.media"
], - "type": 1
}Response samples
- 200
{- "domainData": [
- {
- "id": 1089273244,
- "it1": 86,
- "it5": 45527,
- "it10": 742944,
- "it50": 1683529,
- "name": "lamoda.ru",
- "adcost": 1110959,
- "adkeyscnt": 73239,
- "adscnt": 16075,
- "adTraf": 75
}
], - "joins": [
- {
- "sets": [
- 30457180,
- 277076264
], - "size": 183
}
]
}Доля конкурентов по поисковым фразам - создание отчета
Создание отчета и получение идентификатора, который понадобится в дальнейшем для взаимодействия с отчетом.
Authorizations:
Request Body schema: application/json
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| top | integer Default: 10 Enum: 10 50 Охват позиций |
| list required | Array of strings Список поисковых фраз |
Responses
Request samples
- Payload
{- "base": "msk",
- "top": 10,
- "list": [
- "справка от фтизиатра онлайн",
- "заключение от фтизиатра",
- "запись на прием к врачу"
]
}Response samples
- 200
{- "uid": "96716504gf5a491bffd731bb10bf7dc489"
}Доля конкурентов по поисковым фраза - статус обработки отчета
Пример запроса https://api.keys.so/tools/concurents_by_keywords/state/0906fcc6567fcc8f090bd00ade39ada
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Responses
Response samples
- 200
{- "state": 10,
- "progress": 100
}Доля конкурентов по поисковым фразам - отчет
Пример запроса https://api.keys.so/tools/concurents_by_keywords/96716504gf5a491bffd731bb10bf7dc489?base=msk&view=organic&sort=it50%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
query Parameters
| view | string Default: "organic" Enum: "organic" "context" Отчет вернет результаты для органики( |
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 1089273244,
- "it1": 86,
- "it3": 302770,
- "it5": 45527,
- "it10": 742944,
- "it50": 1683529,
- "name": "lamoda.ru",
- "perc": 28.1,
- "spec": 16,
- "gar": 19,
- "cnt": 1
}
]
}Главные темы сайта
Пример запроса https://api.keys.so/tools/site-themes?base=msk&site=keys.so&minWs=0&maxWs=999999999&minPos=1&maxPos=50&qbyUrl=1&words=1&like=%D0%BA%D0%BE%D0%BD%D0%BA%D1%83%D1%80%D0%B5%D0%BD%D1%82%D1%8B¬Like=%D1%82%D0%B5%D0%BC%D0%B0&sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| site required | string Example: site=keys.so |
| minWs | integer Example: minWs=2 Частотность не менее |
| maxWs | integer Example: maxWs=3 Частотность не более |
| minWsk | integer Example: minWsk=3 [!Частотность] не менее |
| maxWsk | integer Example: maxWsk=4 [!Частотность] не более |
| minPos | integer Example: minPos=3 Позиция от |
| maxPos | integer Example: maxPos=9 Позиция до |
| qbyUrl | integer Example: qbyUrl=1 Запросов с одной страницы |
| words | string Example: words=keys.so Частотность не более |
| like | string Example: like=Конкуренты Похож |
| notLike | string Example: notLike=Позиции Не похож |
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "avbid": 5,
- "cnt": 479138,
- "docs": 732392,
- "isgeo": 0,
- "isquest": 0,
- "numwords": 5,
- "serpf": "10.06.2024",
- "superwsk": 32765856,
- "ws": 14791338,
- "wsk": 86990,
- "url": "/catalog/464638/detail.aspx",
- "word": "как сделать ремонт на балконе"
}
]
}Список запросов страниц - создание отчета
Создание отчета и получение идентификатора, который понадобится в дальнейшем для взаимодействия с отчетом.
Authorizations:
Request Body schema: application/json
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| top | integer Default: 10 Enum: 10 50 Охват позиций |
| list required | Array of strings Список запросов страниц |
Responses
Request samples
- Payload
{- "base": "msk",
- "top": 10,
- "list": [
- "dodopizza.ru/VerkhnyayaPyshma/bonusactions",
- "dodopizza.ru/moscow/product/pepperoni-tomat",
- "dodopizza.ru/verkhnyayapyshma/verkhnyayapyshma"
]
}Response samples
- 200
{- "uid": "96716504gf5a491bffd731bb10bf7dc489"
}Список запросов страниц - статус обработки отчета
Пример запроса https://api.keys.so/tools/keywords_by_pages/state/3701a9cfcb2f9f72259e8ee717056f
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Responses
Response samples
- 200
{- "state": 10,
- "progress": 100
}Список запросов страниц - отчет по весу
Пример запроса https://api.keys.so/tools/keywords_by_pages/weight/7faaefe0jkdaab0009h1226a5dc4de16?base=msk&sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "avbid": 5,
- "docs": 732392,
- "isgeo": 0,
- "isquest": 0,
- "numwords": 5,
- "serpf": "24.09.2022",
- "superwsk": 32765856,
- "ws": 14791338,
- "wsk": 86990,
- "weight": 4,
- "word": "ecco remote отзывы"
}
]
}Список запросов страниц - отчет по страницам
Пример запроса https://api.keys.so/tools/keywords_by_pages/pages/7faaefe0jkdaab0009h1226a5dc4de16?base=msk&sort=wsk%7Cdesc&page=1&per_page=25
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "avbid": 5,
- "docs": 732392,
- "isgeo": 0,
- "isquest": 0,
- "name": "wildberries.ru",
- "numwords": 5,
- "serpf": "24.09.2022",
- "superwsk": 32765856,
- "ws": 14791338,
- "wsk": 86990,
- "word": "ecco remote отзывы",
- "url": "/catalog/464638/detail.aspx",
- "pos": 5
}
]
}Расширение словаря по странице - создание отчета
Создание отчета и получение идентификатора, который понадобится в дальнейшем для взаимодействия с отчетом.
Authorizations:
Request Body schema: application/json
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| url required | string URL исходной страницы |
required | object Настройки |
Responses
Request samples
- Payload
{- "base": "msk",
- "url": "dodopizza.ru/VerkhnyayaPyshma/bonusactions",
- "config": {
- "list": [
- "фраза"
], - "more": true,
- "pages": [
- "example.ru/top"
], - "useList": true,
- "usePages": true
}
}Response samples
- 200
{- "uid": "96716504gf5a491bffd731bb10bf7dc489",
- "base": "msk"
}Расширение словаря по странице - статус обработки отчета
Пример запроса https://api.keys.so/tools/dictionary-ext-by-page/state/0906fcc65ea67fcc8f090bd00ade39ada
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Responses
Response samples
- 200
{- "state": 10,
- "progress": 100
}Расширение словаря по странице - отчет
Пример запроса https://api.keys.so/tools/dictionary-ext-by-page/f5ce44356458eef19f3a45c019a3267?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Responses
Response samples
- 200
{- "list": [
- "фраза"
], - "more": true,
- "pages": [
- "example.ru/top"
], - "url": "dodopizza.ru/VerkhnyayaPyshma/bonusactions",
- "useList": true,
- "usePages": true,
- "state": 10,
- "result": [
- {
- "exist": [
- {
- "count": 26,
- "keys": [
- "фраза",
- "фраза2"
], - "open": 0,
- "sumSuperwsk": 26,
- "sumWs": 26,
- "sumWsk": 26,
- "words": [
- "фраза",
- "фраза2"
]
}
], - "keys": [
- {
- "superwsk": 2,
- "wsk": 2,
- "ws": 2,
- "word": "фраза"
}
], - "list": [
- "фраза",
- "фраза2"
], - "notExists": [
- {
- "count": 26,
- "keys": [
- "фраза",
- "фраза2"
], - "open": 0,
- "sumSuperwsk": 26,
- "sumWs": 26,
- "sumWsk": 26,
- "words": [
- "фраза",
- "фраза2"
]
}
]
}
]
}Словарь слов по страницам - создание отчета
Создание отчета и получение идентификатора, который понадобится в дальнейшем для взаимодействия с отчетом.
Authorizations:
Request Body schema: application/json
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| pages required | Array of arrays Список страниц |
object Настройки |
Responses
Request samples
- Payload
{- "base": "msk",
- "pages": [
- "dodopizza.ru/VerkhnyayaPyshma/bonusactions",
- "dodopizza.ru/bonusactionsz"
], - "config": {
- "more": true
}
}Response samples
- 200
{- "uid": "96716504gf5a491bffd731bb10bf7dc489"
}Словарь слов по страницам - статус обработки отчета
Пример запроса https://api.keys.so/tools/dictionary-by-pages/state/0906fcc6567fcc8f090bd00ade39ada
Authorizations:
path Parameters
| uid required | string Идентификатор отчёта |
Responses
Response samples
- 200
{- "state": 10,
- "progress": 100
}Словарь слов по страницам - отчет
Пример запроса https://api.keys.so/tools/dictionary-by-pages/659cc524aba41a0252e0a27535f8a064?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Responses
Response samples
- 200
{- "more": true,
- "uid": "659cc524aba41a0252e0a27535f8a064",
- "state": 10,
- "pages": [
- "keys.so",
- "text.ru/"
], - "result": [
- {
- "keys": [
- {
- "superwsk": 2,
- "wsk": 2,
- "ws": 2,
- "word": "фраза"
}
], - "words": [
- {
- "count": 26,
- "keys": [
- "фраза",
- "фраза2"
], - "open": 0,
- "sumSuperwsk": 26,
- "sumWs": 26,
- "sumWsk": 26,
- "words": [
- "фраза",
- "фраза2"
]
}
]
}
]
}Пакетный анализ
Пример запроса https://api.keys.so/tools/domains-batch?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
required | object Данные для анализа |
object Параметры запроса в теле |
Responses
Request samples
- Payload
{- "data": {
- "domains": [
- "senler.ru",
- "sigmasms.ru",
- "smsdar.ru",
- "smspobeda.ru",
- "bandlink.media"
]
}, - "params": {
- "filter": "string",
- "per_page": 25,
- "page": 1,
- "sort": "string"
}
}Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "messageCollapse": {
- "text": "<b>it4power.ru</b>",
- "title": "В базе keys.so по текущему региону нет данных по некоторым доменам (1 из 8)."
}, - "data": [
- {
- "id": 30457180,
- "adcost": 11109590,
- "adkeyscnt": 732392,
- "adscnt": 16075,
- "adskeys": 0,
- "adtraf": 33507,
- "it1": 869,
- "it3": 277,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683,
- "keyspage": 16,
- "name": "wildberries.ru",
- "pagesinindex": 1177,
- "result": 0,
- "topkeys": 99,
- "topvis": 141,
- "traf": 3,
- "vis": 110373
}
]
}Пакетный анализ по ссылкам
Пример запроса https://api.keys.so/report/simple/links/domains-batch?base=msk
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Request Body schema: application/json
required | object Данные для анализа |
object Параметры запроса в теле |
Responses
Request samples
- Payload
{- "data": {
- "domains": [
- "senler.ru",
- "sigmasms.ru",
- "smsdar.ru",
- "smspobeda.ru",
- "bandlink.media"
]
}, - "params": {
- "filter": "string",
- "per_page": 25,
- "page": 1,
- "sort": "string"
}
}Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 30457180,
- "it10": 742944,
- "it50": 1683,
- "name": "wildberries.ru",
- "vis": 110373,
- "numurl": 155,
- "numlink": 1,
- "numdomain": 1,
- "numip": 1000,
- "dr": 0
}
]
}Сравнение сайтов в органическом поиске
Пример запроса https://api.keys.so/report/compare?base=msk&incl=keys.so,text.ru&excl=&view=organic&sort=numwords%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| view | string Default: "organic" Enum: "organic" "context" "backlinks" Тип отчета |
| incl required | string Default: false Список доменов через запятую |
| excl required | string Default: false Список доменов через запятую |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "avbid": 5,
- "docs": 732392,
- "isgeo": 0,
- "isquest": 0,
- "numwords": 5,
- "serpf": "24.06.2024",
- "superwsk": 32765856,
- "word": "создать игру на андроид",
- "ws": 31497995,
- "wsk": 185018
}
]
}Сравнение сайтов в контекстной рекламе
Пример запроса https://api.keys.so/report/compare?base=msk&incl=keys.so,text.ru&excl=&view=organic&sort=numwords%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| view | string Default: "organic" Enum: "organic" "context" "backlinks" Тип отчета |
| incl required | string Default: false Список доменов через запятую |
| excl required | string Default: false Список доменов через запятую |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "adscnt": 16075,
- "avbid": 5,
- "docs": 732392,
- "isgeo": 0,
- "isquest": 0,
- "numwords": 5,
- "serpf": "24.06.2024",
- "word": "создать игру на андроид",
- "ws": 31497995,
- "wsk": 185018,
- "superwsk": 32765856
}
]
}Сравнение сайтов по ссылкам
Пример запроса https://api.keys.so/report/compare?base=msk&incl=keys.so,text.ru&excl=&view=backlinks&sort=numurl%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| view | string Default: "organic" Enum: "organic" "context" "backlinks" Тип отчета |
| incl required | string Default: false Список доменов через запятую |
| excl required | string Default: false Список доменов через запятую |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "numurl": 15542,
- "vis": 110373,
- "ip": "94.198.51.98",
- "numlink": 1,
- "it10": 742944,
- "it50": 1683529,
- "name": "wildberries.ru",
- "dr": 67
}
]
}Рейтинг сайтов по видимости
Пример запроса https://api.keys.so/report/simple/top_domain_visibility?base=msk&domain=dodopizza.ru&sort=&page=54&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adcost": 11109590,
- "adkeyscnt": 732392,
- "adscnt": 16075,
- "adtraf": 33507,
- "id": 29918348,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "name": "rtvi.com",
- "pagesinindex": 117711,
- "topvis": 141
}
]
}Поддомены сайта
Пример запроса https://api.keys.so/report/owner/subdomains?id=dodopizza.ru&base=msk&sort=name%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| id required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "adcost": 11109590,
- "adkeyscnt": 732392,
- "adscnt": 16075,
- "adtraf": 33507,
- "it3": 302770,
- "it5": 455279,
- "it10": 742944,
- "it50": 1683529,
- "name": "rtvi.com",
- "pagesinindex": 117711,
- "vis": 1
}
]
}Объявления Yandex.Direct по домену
Пример запроса https://api.keys.so/report/simple/direct/domain?base=msk&domain=wildberries.ru&sort=keys_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| domain required | string Имя домена |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "description": "string",
- "domain": "fabrikaokon.ru",
- "keys_count": 63898,
- "link": "fabrikaokon.ru",
- "regions": "Россия (кроме: Дальний Восток)",
- "title": "Онлайн-магазин одежды и товаров",
- "updated_at": "26.05.2024",
- "uuid": "6d92874cb389a50d8b70cca8cddb73beda4f7dc3a87c5d75801f55bedafa748d7ca5a0"
}
]
}Объявления Yandex.Direct по запросу
Пример запроса https://api.keys.so/report/simple/direct/ads?base=msk&kid=17222067&sort=keys_count%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
| kid required | integer Идентификатор фразы |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "description": "string",
- "domain": "fabrikaokon.ru",
- "keys_count": 63898,
- "link": "fabrikaokon.ru",
- "regions": "Россия (кроме: Дальний Восток)",
- "title": "Онлайн-магазин одежды и товаров",
- "updated_at": "26.05.2024",
- "uuid": "6d92874cb389a50d8b70cca8cddb73beda4f7dc3a87c5d75801f55bedafa748d7ca5a0"
}
]
}Объявления в РСЯ
Пример запроса https://api.keys.so/report/ads/rsya?sort=&page=1&per_page=25&groupingBy=erir&filter=titleLIKE%25D0%259A%25D1%2580%25D0%25BE%25D1%2581%25D0%25BE%25D0%25B2%25D0%25BA%25D0%25B8%255EORlegalLIKE%25D0%259A%25D1%2580%25D0%25BE%25D1%2581%25D0%25BE%25D0%25B2%25D0%25BA%25D0%25B8%255EORtarget_urlLIKE%25D0%259A%25D1%2580%25D0%25BE%25D1%2581%25D0%25BE%25D0%25B2%25D0%25BA%25D0%25B8
Authorizations:
query Parameters
| groupingBy | string Enum: "img_path" "inn" "domain" "erir" Группировка. Данный параметр работает только при наличии фильтра. |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "message": "Информационное сообщение к отчету",
- "data": [
- {
- "id": "1833034871623477182",
- "title": "Hyundai Solaris 2016",
- "company_name": "",
- "second_title": "",
- "body": "Седан. 2016. 1.6 Механика Бензин (123 л.с.). Узнать подробнее!",
- "files": [
- "e19052b0a6d345e599b786eba834e00806320574f6e077ea2718e15ac58376bca01783742bfb215e7df8676625a650e41f3e86252bc3a671c4a9c123b38b8818.webp"
], - "domain": "avto-nomia-expert.ru",
- "view_cnt": 7,
- "type": "Директ",
- "size": "Адаптив",
- "diff_days": "18",
- "found_at": "08.06.24 16:33",
- "updated_at": "26.06.24 17:00",
- "region_name": "Красноярск",
- "legal": "ООО ЮРАЛ ТРЭЙД, ИНН 6685129317, Рекламодатель ЕРИР #100479617",
- "hash": 133776045420048200,
- "group": [
- { }
]
}
]
}Объявления в РСЯ сайта
Пример запроса https://api.keys.so/report/ads/rsya/domains/dodopizza.ru?sort=found_at%7Casc&page=1&per_page=25
Authorizations:
path Parameters
| domain required | string Example: dodopizza.ru Домен |
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "message": "Информационное сообщение к отчету",
- "data": [
- {
- "id": "1833034871623477182",
- "title": "Hyundai Solaris 2016",
- "company_name": "",
- "second_title": "",
- "body": "Седан. 2016. 1.6 Механика Бензин (123 л.с.). Узнать подробнее!",
- "puny_domain": "dodopizza.ru",
- "files": [
- "e19052b0a6d345e599b786eba834e00806320574f6e077ea2718e15ac58376bca01783742bfb215e7df8676625a650e41f3e86252bc3a671c4a9c123b38b8818.webp"
], - "type": "Директ",
- "size": "Адаптив",
- "diff_days": "18",
- "found_at": "08.06.24 16:33",
- "updated_at": "26.06.24 17:00",
- "legal": "ООО ЮРАЛ ТРЭЙД, ИНН 6685129317, Рекламодатель ЕРИР #100479617"
}
]
}Онлайн парсер Wordstat - список заданий на парсинг
Пример запроса https://api.keys.so/wordstat/list?sort=created_at%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| isMain | boolean Default: false Example: isMain=true Список проектов: |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "base": 38,
- "batches": 1,
- "batches_total": 10,
- "cluster_name": "Проект от 15.04.2025, 14:00",
- "cluster_uid": "4591b69b06d4359229d919c494c17c84",
- "created_at": "01.07.2024 12:31:07",
- "id": 123,
- "monitoring_id": 0,
- "monitoring_name": "keys.so",
- "name": "Тестовый проект",
- "swsk_sum": 10,
- "updated_at": "01.07.2024 12:31:07",
- "words_count": 10,
- "ws_sum": 6284622
}
]
}Онлайн парсер Wordstat - список готовых проектов
Пример запроса https://api.keys.so/wordstat/get-projects-completed?ids=5672,3421,342
Authorizations:
query Parameters
| ids | string Example: ids=5672,3421,342 ID проектов через запятую |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "id": 123,
- "base": 1,
- "name": "Тестовый проект",
- "batches": 1,
- "batches_total": 10,
- "created_at": "01.07.2024 12:31:07",
- "updated_at": "01.07.2024 12:31:07",
- "swsk_sum": 10,
- "ws_sum": 6284622,
- "words_count": 10
}
]
}Онлайн парсер Wordstat - создание задания
Пример запроса https://api.keys.so/wordstat/create-project
Authorizations:
Request Body schema: application/json
required | object Данные для парсинга |
Responses
Request samples
- Payload
{- "data": {
- "name": "Имя проекта",
- "regionId": 1,
- "words": [
- "фраза1",
- "фраза2",
- "фраза3"
], - "type": 1
}
}Response samples
- 200
[ ]Онлайн парсер Wordstat - обновление данных проекта
Обновить данные по созданному проекту
Пример запроса https://api.keys.so/wordstat/update-project
Authorizations:
Request Body schema: application/json
required | object Данные |
Responses
Request samples
- Payload
{- "data": {
- "projectId": 1
}
}Response samples
- 200
[ ]Онлайн парсер Wordstat - удаление проекта
Пример запроса https://api.keys.so/wordstat/delete-project
Authorizations:
Request Body schema: application/json
required | object Данные |
Responses
Request samples
- Payload
{- "data": {
- "projectId": 1
}
}Response samples
- 200
[ ]Онлайн парсер Wordstat - проверка статуса завершения обновления
Пример запроса https://api.keys.so/wordstat/get-project-status?id=5672
Authorizations:
query Parameters
| id | integer Example: id=5672 ID проекта |
Responses
Response samples
- 200
{- "batches": 1,
- "batches_total": 10
}Онлайн парсер Wordstat - добавление/обновление слов
Пример запроса https://api.keys.so/wordstat/update-words
Authorizations:
Request Body schema: application/json
required | object Данные для парсинга |
Responses
Request samples
- Payload
{- "data": {
- "projectId": 1,
- "words": [
- "фраза1",
- "фраза2",
- "фраза3"
], - "type": 1
}
}Response samples
- 200
[ ]Онлайн парсер Wordstat - удаление слов
Пример запроса https://api.keys.so/wordstat/delete-words
Authorizations:
Request Body schema: application/json
required | object Данные для парсинга |
Responses
Request samples
- Payload
{- "data": {
- "projectId": 1,
- "words": [
- "фраза1",
- "фраза2",
- "фраза3"
]
}
}Response samples
- 200
[ ]Онлайн парсер Wordstat - результат парсинга частотности
Пример запроса https://api.keys.so/wordstat/report?projectId=1&sort=swsk%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| projectId required | integer Example: projectId=1 Идентификатор проекта |
| full | any При наличии данного параметра будет отдан полный отчет, при отсутствии ответ будет сгруппирован по запросу |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "id": "приказ 29н медосмотры для медицинских работников",
- "word": "приказ 29н медосмотры для медицинских работников",
- "numwords": 6,
- "type": "Похожие",
- "initial_word": "справка врача фтизиатра",
- "ws": 234,
- "wsGraph": [
- {
- "date": "30.06.2024",
- "count": 2
}
], - "qwsk": 0,
- "wsk": 0,
- "swsk": 0,
- "bdg100": 0,
- "bdg85": 0,
- "bdg62": 0,
- "bdg9": 0,
- "bdg5": 0,
- "cpc100": 0,
- "cpc85": 0,
- "cpc62": 0,
- "cpc9": 0,
- "cpc5": 0,
- "reason": "",
- "updated_at": "01.07.2024 12:31:29"
}
]
}Онлайн парсер выдачи - список заданий на парсинг
Пример запроса https://api.keys.so/serp?sort=created_at%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| isMain | boolean Default: false Example: isMain=true Список проектов: |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "data": [
- {
- "base": 38,
- "base_name": "Москва",
- "batches": 1,
- "batches_total": 10,
- "cluster_name": "Проект от 15.04.2025, 14:00",
- "cluster_uid": "4591b69b06d4359229d919c494c17c84",
- "created_at": "2024-10-25 14:55:22",
- "id": 123,
- "monitoring_id": 0,
- "monitoring_name": "keys.so",
- "name": "Тестовый проект",
- "search_engine": "Google (мобильный)",
- "top_number": 100,
- "updated_at": "2025-04-15 16:05:53",
- "words_count": 10
}
]
}Онлайн парсер выдачи - создание задания
Пример запроса https://api.keys.so/serp
Authorizations:
Request Body schema: application/json
required | object Данные для парсинга |
Responses
Request samples
- Payload
{- "data": {
- "name": "Имя проекта",
- "regionId": 38,
- "topNumber": 10,
- "searchEngine": 0,
- "words": [
- "фраза1",
- "фраза2",
- "фраза3"
]
}
}Response samples
- 200
[ ]Онлайн парсер выдачи - результат парсинга частотности (группировка по фразам)
Пример запроса https://api.keys.so/serp/<id>
Authorizations:
query Parameters
| searchEngine | boolean Default: true Получать данные выдачи поисковых систем |
| organic | boolean Default: true Example: organic=true Получать данные органической выдачи |
| context | boolean Default: true Example: context=true Получать данные контекстной рекламы |
| wizard | boolean Default: true Получать данные колдунщиков |
| word | string Example: word=что такое Фильтр по фразе, поддерживаются операторы -, +: -слово - стоп-слово +слово - без зависимости порядка слов в остальных случаях учитывается порядок слов |
| limit | boolean Example: limit=true Лимит по фразам |
Responses
Response samples
- 200
{- "<фраза>": [
- {
- "contextHash": "15671016654706901873",
- "description": "деревянная теплица фото",
- "domain": "keys.so",
- "errors": "",
- "legal": "ООО «Legal»",
- "pos": 0,
- "subType": "map",
- "title": "деревянная теплица",
- "type": "wizard",
- "word": "деревянная теплица"
}
]
}Онлайн парсер выдачи - результат парсинга частотности
Пример запроса https://api.keys.so/serp/<id>/csv?searchEngine=false&organic=true&context=true&wizard=true
Authorizations:
query Parameters
| searchEngine | boolean Default: true Получать данные выдачи поисковых систем |
| organic | boolean Default: true Example: organic=true Получать данные органической выдачи |
| context | boolean Default: true Example: context=true Получать данные контекстной рекламы |
| wizard | boolean Default: true Получать данные колдунщиков |
| word | string Example: word=что такое Фильтр по фразе, поддерживаются операторы -, +: -слово - стоп-слово +слово - без зависимости порядка слов в остальных случаях учитывается порядок слов |
Responses
Response samples
- 200
[- {
- "contextHash": "15671016654706901873",
- "description": "деревянная теплица не дорого в Москве",
- "domain": "keys.so",
- "errors": "",
- "legal": "ООО «Legal»",
- "pos": 1,
- "subType": "companies.company",
- "title": "деревянная теплица не дорого",
- "type": "wizard",
- "word": "деревянная теплица"
}
]Онлайн парсер выдачи - сайты конкурентов
Пример запроса https://api.keys.so/serp/<id>/competitor-domains
Authorizations:
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| organic | boolean Default: true Учитывать данные органической выдачи |
| context | boolean Default: true Учитывать данные контекстной рекламы |
Responses
Response samples
- 200
{- "total": 150,
- "data": [
- {
- "cnt": 5,
- "did": 29918164,
- "domain": "keys.so"
}
]
}Онлайн парсер выдачи - страницы конкурентов
Пример запроса https://api.keys.so/serp/<id>/competitor-pages
Authorizations:
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| organic | boolean Default: true Учитывать данные органической выдачи |
| context | boolean Default: true Учитывать данные контекстной рекламы |
| paramsGET | boolean Default: true Учитывать GET-параметры |
Responses
Response samples
- 200
{- "total": 150,
- "data": [
- {
- "cnt": 5,
- "did": 29918164,
- "domain": "keys.so",
- "url": "/ru/projects",
- "full_url": "keys.so/ru/projects"
}
]
}Дзен - дашборд
Пример запроса https://api.keys.so/zen/dashboard?channel=Text.ru+-+%D0%BF%D0%B8%D1%88%D0%B8+%D0%B8+%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D1%8F%D0%B9
Authorizations:
query Parameters
| channel required | string Example: channel=https://dzen.ru/textru Имя или урл канала |
Responses
Response samples
- 200
{- "name": "Text.ru - пиши и проверяй",
- "description": "",
- "countViews": 27594,
- "countViewsRank": 147512,
- "countTillEndRank": 146498,
- "countTillEnd": 24120,
- "countPosts": 115,
- "subscribers": 868,
- "isActive": true,
- "parsedAt": {
- "date": "2024-06-03 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Moscow"
}
}Дзен - Рейтинг по просмотрам Дзен каналов
Пример запроса https://api.keys.so/zen/top/channels?sort=viewsRank%7Casc&page=1&per_page=25
Authorizations:
query Parameters
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "sort": [ ],
- "data": [
- {
- "id": "592d2faed7d0a6f37914f561",
- "name": "Царьград",
- "views": 1414600382,
- "viewsRank": 1,
- "viewsTillEnd": 1176721004,
- "viewsTillEndRank": 1,
- "countPosts": 100834,
- "subscribers": 1582065,
}
]
}Дзен - Топ новых публикаций Дзен
Пример запроса https://api.keys.so/zen/channel/new/top/publications?sort=countViews%7Cdesc&page=1&per_page=25&forDay=30
Authorizations:
query Parameters
| forDay | integer Default: 3 Период |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "sort": [ ],
- "data": [
- {
- "channelTitle": "Страдающее Средневековье",
- "typeLabel": "Пост",
- "title": "!!!",
- "description": "!!!",
- "countComments": 0,
- "countViews": 33,
- "countViewsTillEnd": 33,
- "countLikes": 9,
- "datePublishAt": {
- "date": "2024-06-30 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Moscow"
}
}
]
}Дзен - Публикации канала
Пример запроса https://api.keys.so/zen/channel/publications?channel=5e428f13bf8d3263221b5924&sort=datePublishAt%7Cdesc&page=1&per_page=25
Authorizations:
query Parameters
| channel required | string Example: channel=Text.ru - пиши и проверяй Хеш, имя или урл канала для поиска |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "last_page": 85,
- "per_page": 25,
- "total": 2124,
- "sort": [ ],
- "data": [
- {
- "typeLabel": "Пост",
- "title": "!!!",
- "description": "!!!",
- "countComments": 0,
- "countViews": 33,
- "countViewsTillEnd": 33,
- "countLikes": 9,
- "datePublishAt": {
- "date": "2024-06-30 00:00:00.000000",
- "timezone_type": 3,
- "timezone": "Europe/Moscow"
}
}
]
}Лимиты по инструментам
Пример запроса https://api.keys.so/limits/all
Authorizations:
Responses
Response samples
- 200
{- "analysis": {
- "limit": 3000,
- "usedLimit": 1
}, - "apiRequest": {
- "limit": 25000,
- "usedLimit": 0
}, - "users": {
- "limit": 10,
- "usedLimit": 0
}, - "keysReportLimit": {
- "limit": 15000000
}, - "recordsPerReport": {
- "limit": 300000
}, - "recordsExportPerReport": {
- "limit": 300000
}, - "sitesCompare": {
- "limit": 30,
- "maxRequestsInTop50": 15000000
}, - "projects": {
- "limit": 100,
- "usedLimit": 1
}, - "searchKeys": {
- "perDay": {
- "limit": 300,
- "usedLimit": 0
}, - "perMonth": {
- "limit": 1000,
- "usedLimit": 0
}, - "requestLinesLimit": 3000
}, - "domainsBatch": {
- "perDay": {
- "limit": 300,
- "usedLimit": 0
}, - "perMonth": {
- "limit": 1000,
- "usedLimit": 0
}, - "listLimit": 1000
}, - "keywordsByList": {
- "perDay": {
- "limit": 300,
- "usedLimit": 0
}, - "perMonth": {
- "limit": 1000,
- "usedLimit": 0
}, - "listLimit": 50000
}, - "rsya": {
- "recordsExportPerReport": 300000,
- "perDay": {
- "limit": 3000,
- "usedLimit": 1
}
}, - "suggest": {
- "perDay": {
- "limit": 300,
- "usedLimit": 0
}, - "listLimit": 100
}, - "wordstat": {
- "perMonth": {
- "limit": 1000000,
- "usedLimit": 0
}
}, - "wordstatMaxActiveProjects": {
- "limit": 0
}, - "wordstatWord": {
- "perMonth": {
- "limit": 0,
- "usedLimit": 0
}
}, - "dzen": {
- "publicationsExportRow": 300000,
- "newTopPublicationsExportRow": 300000,
- "topChannelsExportRow": 300000
}, - "treePages": {
- "treePagesRows": 300000
}, - "groupReport": {
- "maxDomainsNumber": 100,
- "maxRequests": 15000000
}, - "concurrentByKeywords": {
- "concurrentByKeywordsLimit": 3000
}, - "extendedKeywords": {
- "recordsPerListLimit": 3000
}, - "clustering": {
- "wordsLimit": 200000,
- "atTime": 1,
- "numberLimit": 1000
}, - "checkTop": {
- "maxWords": 3000
}
}Анализ robots.txt - даты изменения файла
Пример запроса https://api.keys.so/robots/dates?domain=keys.so
Authorizations:
query Parameters
| domain required | string Example: domain=keys.so Имя домена |
Responses
Response samples
- 200
[- {
- "firstUpdate": "2024-09-14 17:52:01",
- "lastUpdate": "2024-09-14 17:55:36",
- "statusCode": 200
}
]Анализ robots.txt - данные файла за определенную дату
Пример запроса https://api.keys.so/robots/data?domain=keys.so
Authorizations:
query Parameters
| domain required | string Example: domain=keys.so Имя домена |
| date | string Example: date=2024-09-05 09:14:23 Дата изменения, если не указана - последнее изменение |
Responses
Response samples
- 200
{- "dateUpdate": "2024-09-14 17:52:01",
- "robotsSize": 9999999,
- "robotsLines": 124,
- "statusCode": 200,
- "content": "User-agent: *\nDisallow: /ru/too-many-requests",
- "error": "connection refused"
}Мониторинг позиций - список проектов
Пример запроса https://api.keys.so/monitoring
Authorizations:
query Parameters
| search | string Example: search=keys.so Поиск по названию проекта и ключевым словам |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 85,
- "total": 2124,
- "data": [
- {
- "id": 146,
- "name": "keys.so - мониторинг",
- "search_settings": [
- {
- "engine_name": "Яндекс (десктоп)",
- "language": 0,
- "region_id": 38,
- "region_name": "Волгоград",
- "search_engine": 0
}
], - "numwords": 2,
- "avg_pos": 0,
- "delta_avg_pos": 0,
- "created_at": "2025-04-15 14:00:14",
- "last_finished_at": null,
- "next_start_at": null,
- "child_projects": {
- "cluster": {
- "uid": "4591b69b06d4359229d919c494c17c84",
- "name": "Проект от 15.04.2025, 14:00"
}, - "serp": [
- {
- "id": 123,
- "name": "keys.so - monitoring - Волгоград"
}
], - "wordstat": [
- {
- "id": 123,
- "name": "keys.so - monitoring - Волгоград"
}
]
}
}
]
}Мониторинг позиций - создание проекта
Пример запроса https://api.keys.so/monitoring
Authorizations:
Request Body schema: application/jsonrequired
| name | string Название проекта |
| trackingItem required | string Элемент отслеживания (домен/url) |
| trackSubDomains required | boolean Флаг отслеживания поддоменов |
required | Array of objects (searchSettings) Список настроек поисковых систем и регионов |
| serp | boolean Default: false Флаг для включения SERP |
| wordstat | boolean Default: false Флаг для включения статистики слов |
| clusterUuid required | string Уникальный идентификатор кластеризатора |
| keywords | Array of strings Список фраз |
| base | string (base) Default: "msk" Enum: "msk" "gru" "zen" "gkv" "rnd" "ekb" "ufa" "sar" "krr" "prm" "sam" "kry" "oms" "kzn" "che" "nsk" "nnv" "vlg" "vrn" "spb" "mns" "tmn" "gmns" "tom" "gny"
|
Responses
Request samples
- Payload
{- "name": "keys.so - мониторинг",
- "trackingItem": "keys.so",
- "trackSubDomains": true,
- "searchSettings": [
- {
- "regionId": 38,
- "engine": 0
}
], - "serp": false,
- "wordstat": false,
- "clusterUuid": "f6ce68ad381acbb36e68b59971c70f12",
- "keywords": [
- "кластеризатор"
], - "base": "msk"
}Response samples
- 200
{- "alertSetting": {
- "active": false,
- "interval": 1,
- "notifyEmail": false,
- "notifyTelegram": false
}, - "childProjects": [ ],
- "clusterArts": [ ],
- "clusterUuid": "f6ce68ad381acbb36e68b59971c70f12",
- "id": 146,
- "name": "keys.so - мониторинг",
- "nextStartAt": null,
- "schedulerSetting": {
- "checkHour": 0,
- "daysOfMonth": null,
- "checkMinute": 0,
- "type": 0,
- "daysOfWeek": null
}, - "searchSettings": [
- {
- "engine": 0,
- "regionId": 38,
- "regionName": "Волгоград"
}
], - "trackSubDomains": true,
- "trackingItem": "keys.so",
- "trackingItemIcon": ""
}Мониторинг позиций - прогресс обновления проектов
Пример запроса https://api.keys.so/monitoring/state?ids[]=123&ids[]=456&ids[]=789
Authorizations:
query Parameters
| ids[] required | Array of integers Example: ids[]=123&ids[]=456&ids[]=789 Список идентификаторов проектов для получения статусов |
Responses
Response samples
- 200
{- "<projectId>": {
- "progress": 50,
- "details": [
- {
- "name": "Яндекс (десктоп) - Волгоград",
- "type": "serp",
- "progress": 50
}
]
}
}Мониторинг позиций - обновление данных проекта
Обновляем только то, что передали. Пример запроса https://api.keys.so/monitoring/<id>
Authorizations:
Request Body schema: application/jsonrequired
| trackingItem | string Домен или URL для отслеживания |
| trackSubDomains | boolean Флаг для отслеживания поддоменов |
| name | string Название проекта |
Array of objects (searchSettings) Список настроек поисковых систем и регионов | |
object Настройки планировщика | |
object Настройки уведомлений |
Responses
Request samples
- Payload
{- "trackingItem": "keys.so",
- "trackSubDomains": true,
- "name": "keys.so - мониторинг",
- "searchSettings": [
- {
- "regionId": 38,
- "engine": 0
}
], - "schedulerSetting": {
- "type": 1,
- "daysOfWeek": "1,2,3,4,5,6,7",
- "daysOfMonth": null,
- "checkHour": 14,
- "checkMinute": 40
}, - "alertSetting": {
- "active": false,
- "notifyEmail": false,
- "notifyTelegram": false
}
}Response samples
- 200
{- "message": "Проект мониторинга успешно обновлен"
}Мониторинг позиций - удаление проекта
Пример запроса https://api.keys.so/monitoring/<id>
Authorizations:
Request Body schema: application/json
| childs | boolean Default: false Флаг для удаления дочерних элементов (кластеризатора, мониторингов, wordstat) |
Responses
Request samples
- Payload
{- "childs": true
}Response samples
- 200
{- "message": "Проект удален"
}Мониторинг позиций - необходимые лимитов для обновления
Количество необходимых лимитов для обновления, если не указаны данные - всего проекта. Пример запроса https://api.keys.so/monitoring/<id>/limits?searchSettings[]={"regionId":38,"engine":0}&aids[]=-1
Authorizations:
query Parameters
| aids[] | Array of integers Example: aids[]=100 Массив ID папок кластеризатора |
| searchSettings[] | Array of strings Example: searchSettings[]={"regionId":38,"language":0,"engine":0} JSON строка с настройками.
|
Responses
Response samples
- 200
{- "wordstat": 2,
- "serp": 4
}Мониторинг позиций - запуск обновления
Если не переданы оба параметра ids, aids - обновление будет всего проекта. Пример запроса https://api.keys.so/monitoring/<id>/start
Authorizations:
Request Body schema: application/jsonrequired
| serp required | boolean Default: false Флаг для обновления проектов выдачи |
| wordstat | boolean Default: false Флаг для обновления проектов wordstat |
| ids | Array of integers Список идентификаторов фраз для обновления |
| aids | Array of integers Список идентификаторов папок кластеризатора |
Array of objects (searchSettings) Список настроек поисковых систем и регионов |
Responses
Request samples
- Payload
{- "serp": true,
- "wordstat": false,
- "ids": [
- 1,
- 2,
- 3
], - "aids": [
- 10,
- 20
], - "searchSettings": [
- {
- "regionId": 38,
- "engine": 0
}
]
}Response samples
- 200
[ ]Мониторинг позиций - обновление целевого URL у фразы или группы фраз.
Пример запроса https://api.keys.so/monitoring/<id>/link-words
Authorizations:
Request Body schema: application/jsonrequired
| targetUrl required | string Новый целевой URL для фраз |
| wordId required | string Идентификатор фразы (большое число передаётся как строка) |
| aids | Array of numbers Список ID папок кластеризатора |
Responses
Request samples
- Payload
{- "wordId": "982374983274928374928374",
- "aids": [
- 123456,
- 789012
]
}Response samples
- 200
[ ]Мониторинг позиций - все даты, по которым есть данные по фильтру регионов
Пример запроса https://api.keys.so/monitoring/<id>/dates?searchSettings[]={"regionId":38,"engine":0}
Authorizations:
query Parameters
| searchSettings[] | Array of strings Example: searchSettings[]={"regionId":38,"language":0,"engine":0} JSON строка с настройками.
|
Responses
Response samples
- 200
[- "2024-03-01"
]Мониторинг позиций - сущность проекта
Возвращает полное описание сущности проекта, включая настройки поиска, расписания обновления, оповещений и дочерних проектов. Пример запроса https://api.keys.so/monitoring/<id>/entity
Authorizations:
Responses
Response samples
- 200
{- "id": 146,
- "clusterUuid": "4591b69b06d4359229d919c494c17c84",
- "name": "keys.so",
- "trackingItem": "keys.so",
- "trackSubDomains": true,
- "searchSettings": [
- {
- "engine": 0,
- "regionId": 38,
- "regionName": "Волгоград"
}
], - "schedulerSetting": {
- "type": 0,
- "daysOfWeek": "1,2,3,4,5,6,7",
- "daysOfMonth": "10,11,13",
- "checkHour": 11,
- "checkMinute": 0
}, - "alertSetting": {
- "active": false,
- "interval": 1,
- "notifyEmail": false,
- "notifyTelegram": false
}, - "clusterArts": [
- {
- "id": 0,
- "pid": -10,
- "name": "Все узлы",
- "lock": false,
- "keys_count": 0,
- "ws_sum": 0,
- "wsk_sum": 0,
- "superwsk_sum": 0,
- "max_key_ws": 0,
- "max_key_wsk": 0,
- "max_key_superwsk": 0,
- "children": [
- {
- "id": -1,
- "pid": 0,
- "name": "Нераспределенные",
- "lock": true,
- "keys_count": 2,
- "ws_sum": 1195,
- "wsk_sum": 41,
- "superwsk_sum": 41,
- "max_key_ws": 249,
- "max_key_wsk": 36,
- "max_key_superwsk": 36,
- "children": [
- null
]
}
]
}
], - "nextStartAt": "2025-04-17 11:00:00",
- "childProjects": {
- "cluster": {
- "uid": "4591b69b06d4359229d919c494c17c84",
- "name": "Проект от 15.04.2025, 14:00"
}, - "serp": [
- {
- "id": 7546,
- "name": "keys.so - monitoring - Волгоград"
}
], - "wordstat": [
- {
- "id": 7548,
- "name": "keys.so - monitoring - wordstat"
}
]
}
}
Мониторинг позиций - данные для таблицы проекта
Получение отчета по позициям проекта за указанный период с фильтрацией по регионам, папкам и поисковым системам. Пример запроса: https://api.keys.so/monitoring/146/report?dateFrom=2025-04-09&dateTo=2025-04-16&per_page=25&page=1&sort=superwsk|desc&searchSettings[]={"regionId":38,"engine":0}
Authorizations:
query Parameters
| dateFrom required | string <date> Example: dateFrom=2025-04-09 Начальная дата периода в формате YYYY-MM-DD |
| dateTo required | string <date> Example: dateTo=2025-04-16 Конечная дата периода в формате YYYY-MM-DD |
| searchSettings[] | Array of strings Example: searchSettings[]={"regionId":38,"language":0,"engine":0} JSON строка с настройками.
|
| aids | Array of integers Example: aids=1&aids=2&aids=3 Массив папок кластеризатора |
| search | string Example: search= |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "current_page": 1,
- "per_page": 25,
- "last_page": 1,
- "total": 2,
- "data": [
- {
- "project_id": 146,
- "word_id": "17320300850608973793",
- "word_aid": -1,
- "word": "кластеризатор",
- "ws": 249,
- "wsk": 36,
- "superwsk": 36,
- "relevant_url": "keys.so/ru/clustering",
- "snippets": {
- "<hash>": {
- "hash": "2af05303c936a2a7",
- "title": "Кластеризация запросов онлайн — сервис группировки...",
- "desc": "Добавьте ключевые запросы в кластеризатор...",
}
}, - "dates": [
- {
- "date": "2025-04-15",
- "found_at": "2025-04-15",
- "checks_count": 1,
- "check_status": "found",
- "organic_pos": 6,
- "real_pos": 6,
- "avg_organic_pos": 6,
- "avg_real_pos": 6,
- "delta_organic_pos": 0,
- "delta_real_pos": 0,
- "delta_avg_organic_pos": 0,
- "delta_avg_real_pos": 0,
- "url": "keys.so/ru/clustering",
- "relevant_url": "keys.so/ru/clustering",
- "snippet_hash": "2af05303c936a2a7",
- "serp_project_id": 7546,
- "search_engine": 0,
- "region_id": 38,
- "region_name": "Волгоград"
}
]
}
]
}Мониторинг позиций - данные для графика
Получение агрегированных данных по позициям фраз проекта для графика. Пример запроса: https://api.keys.so/monitoring/146/report-compare?dateFrom=2025-04-09&dateTo=2025-04-16&per_page=25&page=1&sort=superwsk|desc&searchSettings[]={"regionId":38,"engine":0}
query Parameters
| dateFrom required | string <date> Начальная дата периода |
| dateTo required | string <date> Конечная дата периода |
| searchSettings[] | Array of strings Example: searchSettings[]={"regionId":38,"language":0,"engine":0} JSON строка с настройками.
|
| aids | Array of integers ID папок кластеризатора |
| search | string Поисковый запрос по фразам |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "data": {
- "<date>": {
- "it1_organic": 0,
- "it3_organic": 0,
- "it5_organic": 0,
- "it10_organic": 1,
- "it50_organic": 1,
- "it100_organic": 2,
- "it100_plus_organic": 2,
- "day_avg_organic_pos": 49.5,
- "avg_organic_vis": 0,
- "total_words": 2,
- "words_with_snippet": 2,
- "it5_organic_percent_total_words": 0
}
}
}Мониторинг позиций - данные сравнения c предыдущим съёмом
Получение агрегированных сравнительных данных по фразам между текущим и предыдущим съёмом. Пример запроса: https://api.keys.so/monitoring/146/report-compare?dateFrom=2025-04-09&dateTo=2025-04-16&per_page=25&page=1&sort=superwsk|desc&searchSettings[]={"regionId":38,"engine":0}
Authorizations:
query Parameters
| searchSettings[] | Array of strings Example: searchSettings[]={"regionId":38,"language":0,"engine":0} JSON строка с настройками.
|
| aids | Array of integers ID папок кластеризатора (aids) |
| dateFrom required | string <date> Дата начала периода |
| dateTo required | string <date> Дата окончания периода |
| search | string Строка поиска |
| page | integer Default: 1 Порядковый номер страницы результатов |
| per_page | integer Default: 25 Количество результатов на одной странице |
| sort | string Сортировка данных по полям. |
| filter | string Подробнее про фильтрацию смотрите в разделе Фильтрация данных |
Responses
Response samples
- 200
{- "words_count": 2,
- "words_without_change_pos": 0,
- "words_negative_change_pos": 0,
- "words_positive_change_pos": 2,
- "avg_vis": 0,
- "avg_organic_pos": 50,
- "top5_percent": 0,
- "avg_traffic": 0,
- "avg_delta_vis": 0,
- "avg_delta_organic_pos": 50,
- "top5_percent_delta": -100,
- "avg_delta_traffic": 0,
- "top1_count": 0,
- "top1_delta": 0,
- "top5_count": 0,
- "top5_delta": -2,
- "top10_count": 1,
- "top10_delta": -1,
- "top50_count": 1,
- "top50_delta": -1,
- "top100_count": 2,
- "top100_delta": 0,
- "top100_plus_count": 2,
- "top100_plus_delta": 0
}