Keys.so API (1.0)

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

Описание

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

Авторизация

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

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

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

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

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

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

current_page

integer

false

Порядковый номер страницы результатов

1

per_page

integer

false

Количество результатов на одной странице

25

sort

string

false

Сортировка данных по полям

Формат: field|direction, где

  • field - имя колонки
  • direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Пример значения:

pos|asc

Пример значения сортировки по двум полям:

pos|asc,wsk|desc

none

filter

string

false

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

none

Фильтрация данных

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

Тип поляУсловиеОператор, формат

string, integer

Строго равен

field=value

string, integer

Строго не равен

field!=value

string

Похож

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

Дашборд

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

Пример запроса: https://api.keys.so/report/simple/domain_dashboard?base=msk&domain=wildberries.ru

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "concs": [
    ],
  • "pages": [
    ],
  • "ads": [
    ],
  • "adkeys": [
    ],
  • "adconcs": [
    ],
  • "history": {
    },
  • "linksHistory": {
    }
}

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

Пример запроса: 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:
X-Keyso-TOKENauth-token
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"


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

keyword
required
string

Поисковый запрос

Responses

Response samples

Content type
application/json
{
  • "id": 29918348,
  • "word": "пластиковые окна",
  • "ws": 31497995,
  • "wsk": 185018,
  • "isgeo": 0,
  • "isquest": 0,
  • "top": [
    ],
  • "ads": [
    ],
  • "similar": [
    ]
}

Групповые отчеты

Список групповых отчетов

Пример запроса https://api.keys.so/report/group/list?sort=access_date%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

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

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
required
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"


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

domains
required
Array of strings

Массив доменов в отчете

name
any

Имя отчета

Responses

Request samples

Content type
application/json
{
  • "base": "msk",
  • "domains": [
    ],
  • "name": null
}

Response samples

Content type
application/json
{
  • "rid": "696b62ec6bceaf00529c4dd4bce02b47"
}

Статус обработки отчета

Пример запроса https://api.keys.so/report/group/state/090e6fcc65ea67fcc8f0bd00ade39a

Authorizations:
X-Keyso-TOKENauth-token

Responses

Response samples

Content type
application/json
{
  • "state": 10,
  • "progress": 100
}

Домены в отчете

Пример запроса https://api.keys.so/report/group/organic/keywords/3aa8f62903adc6fe499d42dcf82a4c8?sort=it50%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/organic/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=wsk%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/organic/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/organic/sitepages/696b62ec6bceaf00529c4dd4bce02b47?sort=vis%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/context/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=weight%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/context/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/context/ads/696b62ec6bceaf00529c4dd4bce02b47?sort=keyscnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/context/ads/links/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/group/context/ads/facts/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
rid
required
string

Идентификатор отчёта

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Органическая выдача

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

Пример запроса https://api.keys.so/report/simple/organic/concurents?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса 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:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page_url
required
string

Url страницы

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/organic/sitepages?base=msk&domain=wildberries.ru&sort=it50%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/organic/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

url
string
Example: url=/

URL

includeSubLevels
integer
Example: includeSubLevels=1

Включить подуровни

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса 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:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page_url
required
string

Url страницы

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/organic/sitepages/withkeys?base=msk&domain=dodopizza.ru&sort=url%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/organic/lost_keywords?base=msk&domain=dodopizza.ru&sort=pos%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/organic/lost_pages?base=msk&domain=dodopizza.ru&sort=it50%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

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

Пример запроса https://api.keys.so/report/simple/context/concurents?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/context/keywords/byads?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

ads_id
required
string

Идентификатор объявления

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/context/keywords?base=msk&domain=wildberries.ru&sort=pos%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": []
}

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

Пример запроса https://api.keys.so/report/simple/context/ads?base=msk&domain=wildberries.ru&sort=keyscnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

full
boolean
Default: false

Если 1, в отчет будет добавлен массив ключевых слов по каждому объявлению

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{}

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

Пример запроса https://api.keys.so/report/simple/context/ads/links?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Пример запроса https://api.keys.so/report/simple/context/ads/facts?base=msk&domain=wildberries.ru&sort=cnt%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
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"


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

domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Запросы

Запросы сервиса

Пример запроса https://api.keys.so/report/system_keywords?strict=true&base=msk&hideadult=true

Authorizations:
X-Keyso-TOKENauth-token
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"


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

strict
required
boolean
Default: true

Нечеткий поиск(поддержка склонения слов, изменения их порядка, не более 1 000 000 результатов)

hideadult
required
boolean
Default: true

Скрыть запросы тематики 18+

page
integer
Default: 1

Порядковый номер страницы результатов

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

Request Body schema: application/json
object

Параметры запроса в теле

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Дополняющие фразы

Пример запроса 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:
X-Keyso-TOKENauth-token
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"


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

keyword
required
string

Поисковый запрос

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
required
list
required
Array of arrays

Массив фраз для чистки дублей

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "exclude": [
    ]
}

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

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
required
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"


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

list
required
Array of strings

Массив фраз

object
Default: {"similarity":30,"deleteDuplicate":true,"additions":false}

Массив фраз

Responses

Request samples

Content type
application/json
{
  • "base": "msk",
  • "list": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uid": "7d9a401359df946e37cbebfc937a5d65"
}

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

Пример запроса https://api.keys.so/tools/extended_keywords/state/7d9a401359df946e37cbebfc937a5d65 полученный в Расширение ключевых фраз - создание задания

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
uid
required
string

Идентификатор отчета

Responses

Response samples

Content type
application/json
{
  • "state": 10,
  • "progress": 100
}

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

Пример запроса https://api.keys.so/tools/extended_keywords/7d9a401359df946e37cbebfc937a5d65?sort=wsk%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
uid
required
string

Идентификатор отчета

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

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

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
required
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"


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

list
required
Array of arrays

Массив фраз

Responses

Request samples

Content type
application/json
{
  • "base": "msk",
  • "list": [
    ]
}

Response samples

Content type
application/json
{
  • "uid": "6684baecf18566c4381fc7731925481"
}

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

Пример запроса https://api.keys.so/tools/keywords_by_list/msk:44:6684baecf18566c4381fc7731925481d?base=msk&sort=wsk%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
uid
required
string

Идентификатор отчета

query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

История выдачи SERP по запросу

Пример запроса https://api.keys.so/tools/history-serp?base=gru

Authorizations:
X-Keyso-TOKENauth-token
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"


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

Request Body schema: application/json
keyword
required
string

Поисковая фраза

Responses

Request samples

Content type
application/json
{
  • "keyword": "купить телефон"
}

Response samples

Content type
application/json
{
  • "<YYYY.MM>": {
    }
}

Подсветка топов

Пример запроса https://api.keys.so/tools/check-top?base=msk

Authorizations:
X-Keyso-TOKENauth-token
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"


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

Request Body schema: application/json
list
required
Array of strings

Список поисковых фраз

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
{
  • "<keyword>": [
    ]
}

Подсветка топов - сайты конкурентов

Пример запроса https://api.keys.so/tools/check-top-concurents-domains?base=msk

Authorizations:
X-Keyso-TOKENauth-token
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"


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

Request Body schema: application/json
list
required
Array of strings

Список поисковых фраз

page
integer

Текущая страница

perPage
integer

Записей на странице

Responses

Request samples

Content type
application/json
{
  • "list": [
    ],
  • "page": 1,
  • "perPage": 25
}

Response samples

Content type
application/json
{
  • "total": 150,
  • "data": [
    ]
}

Подсветка топов - страницы конкурентов

Пример запроса https://api.keys.so/tools/check-top-concurents-urls?base=msk

Authorizations:
X-Keyso-TOKENauth-token
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"


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

Request Body schema: application/json
list
required
Array of strings

Список поисковых фраз

page
integer

Текущая страница

perPage
integer

Записей на странице

Responses

Request samples

Content type
application/json
{
  • "list": [
    ],
  • "page": 1,
  • "perPage": 25
}

Response samples

Content type
application/json
{
  • "total": 150,
  • "data": [
    ]
}

Сравнение списков ключевых фраз

Пример запроса https://api.keys.so/tools/compare

Authorizations:
X-Keyso-TOKENauth-token
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

Content type
application/json
{
  • "left": [
    ],
  • "right": [
    ],
  • "options": "present_right"
}

Response samples

Content type
application/json
[
  • "заключение от фтизиатра",
  • "фтизиатр после пробы манту"
]

Комбинатор ключевых фраз

Пример запроса https://api.keys.so/tools/combine

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
lists
required
Array of arrays

Список поисковых фраз

options
Array of strings

Дополнительные настройки:
Заключить в " " - quotes
Заключить в «[ ]» - brackets
Добавить комбинации без операторов - simple
Добавить «+» к стоп-словам - simple

Responses

Request samples

Content type
application/json
{
  • "lists": {
    },
  • "options": [
    ]
}

Response samples

Content type
application/json
"string"

Выделение уникальных слов в тексте

Пример запроса https://api.keys.so/tools/unique

Authorizations:
X-Keyso-TOKENauth-token
Request Body schema: application/json
list
required
Array of strings

Список поисковых фраз

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
{
  • "count": 18,
  • "open": false,
  • "keys": [
    ],
  • "words": [
    ]
}

Сбор поисковых подсказок в Яндексе

Пример запроса https://api.keys.so/tools/suggest

Authorizations:
X-Keyso-TOKENauth-token
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

Код региона:
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

Content type
application/json
{
  • "list": [
    ],
  • "region": 1
}

Response samples

Content type
application/json

Ссылки

Входящие ссылки

Пример запроса https://api.keys.so/report/simple/links/backlinks?domain=wildberries.ru&sort=created_at%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Исходящие ссылки

Пример запроса https://api.keys.so/report/simple/links/outlinks?domain=wildberries.ru&sort=created_at%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Ссылающиеся домены

Пример запроса https://api.keys.so/report/simple/links/backlinks-domains?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Исходящие домены

Пример запроса https://api.keys.so/report/simple/links/outlinks-domains?domain=wildberries.ru&sort=outlinks_count%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Ссылки по IP

Пример запроса https://api.keys.so/report/simple/links/backlinks-ip?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Ссылки по IP - подсети

Пример запроса https://api.keys.so/report/simple/links/backlinks-ip/subnet?domain=wildberries.ru&sort=domains_count%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Анкоры

Пример запроса https://api.keys.so/report/simple/links/backlinks-anchor?domain=wildberries.ru&sort=backlinks_count%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [
    ]
}

Популярные страницы

Пример запроса https://api.keys.so/report/simple/links/pages?domain=dodopizza.ru&sort=numurl%7Cdesc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
domain
required
string

Имя домена

page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

filter
string

Подробнее про фильтрацию смотрите в разделе Фильтрация данных

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": []
}

Кластеризатор

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

Authorizations:
X-Keyso-TOKENauth-token
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"


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

Responses

Request samples

Content type
application/json
{
  • "list": [
    ],
  • "base": "msk"
}

Response samples

Content type
application/json
{
  • "uid": "msk:44:6684baecf18566c4381fc7731925481"
}

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

Запуск процесса. Вместо UID в уре запроса, идентификатор полученный при создании.

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
uid
required
string

Идентификатор отчёта

Request Body schema: application/json
required
topNumber
integer

Глубина проверки(топ 10, 20, 50)

fStrength
integer

Более общее\мелкие группы(%)

fIsWsk
boolean

Минимальная [!частотность] главного ключа в группе(использовать или нет)

fWsk
integer

Минимальная [!частотность] главного ключа в группе(значение)

fIsSumWsk
boolean

Минимальная суммарная [!частотность] группы(использовать или нет)

fSumWsk
boolean

Минимальная суммарная [!частотность] группы(значение)

Responses

Request samples

Content type
application/json
{
  • "topNumber": 10,
  • "fStrength": 50,
  • "fIsWsk": true,
  • "fWsk": 100,
  • "fIsSumWsk": true,
  • "fSumWsk": true
}

Response samples

Content type
application/json
true

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

Пример запроса https://api.keys.so/clustering/b8095aa8g82defb29f9a1660640fa7f9

Authorizations:
X-Keyso-TOKENauth-token
path Parameters
uid
required
string

Идентификатор отчёта

Responses

Response samples

Content type
application/json
true

Список проектов кластеризатора

Пример запроса https://api.keys.so/clustering/list?sort=access_date%7Casc&page=1&per_page=25

Authorizations:
X-Keyso-TOKENauth-token
query Parameters
page
integer
Default: 1

Порядковый номер страницы результатов

per_page
integer
Default: 25

Количество результатов на одной странице

sort
string

Сортировка данных по полям.

Формат: field|direction, где

field - имя колонки
direction - направление сортировки, asc - по возрастанию, desc - по убыванию

Например: pos|asc, либо по двум полям pos|asc,wsk|desc

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "per_page": 25,
  • "last_page": 85,
  • "total": 2124,
  • "data": [