Documentation of REST API used by Keys.so service

Description of REST API used by the service

Short description

The API interface is used to integrate capabilities of the Keys.so service into our clients' personal projects. This API is intended for developers and comes with detailed documentation.

REST API of the service uses the HTTP protocol to operate and is a set of methods used to make queries and get responses for each operation. All responses arrive as JSON structures.

Authorization

The process of authorization is possible if you have a personal key (token hereinafter), which can be used to subsequently sign every request to API.

A token can be generated in the settings of your personal area in the API block.

Your token will be automatically updated if you change your user password or click "Generate new token".

Your token must be used as the value of X-Keyso-TOKEN header to perform authorized queries.

Example of a key:

X-Keyso-TOKEN: 5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5
Main URL

All links to queries to API in this documentation include the mandatory main URL: https://api.keys.so/

Standard request parameters

Most reports (unless specified otherwise) support the standard request parameters:

Parameter Type Required Description Default value

current_page

integer

false

Sequential number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc – ascending, desc – descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

See details about filtering in the Data filtering section

none

Data filtering mechanism

The filtering mechanism is used together with the default request parameters

Fields which support filtration are listed in documentation of every report.

Fiesld type Condition Operator, format

string, integer

Strictly equal

field=value

string, integer

Strictly non-equal

field!=value

string

Like

fieldLIKEvalue

string

Not like

fieldNOT LIKEvalue

string

Starts with

fieldSTARTSWITHvalue

string

Ends with

fieldENDSWITHvalue

string, integer

Is one of

fieldINvalueA,valueB

string, integer

Is not one of

fieldNOT INvalueA,valueB

integer

Greather than

field>value

integer

Lesser than

field<value

integer

Greather or equal to

field>=value

integer

Lesser or equal to

field<=value

integer

Between

fieldBETWEENvalueA@valueB

Number of fields, which can be included in a filtration request, is not limited.

The mechanism supports AND (^) and OR (^OR) logical operators.

A filter-containing string shall be URL-encoded before sending

An example of creating an AND (^) request:

Filter out all requests that contain the word "toy" with search volume above 170,000
The filter: wordLIKEtoy^ws>170000
Request parameters: filter=wordLIKEtoy%5Ews%3E170000

An example of a request that combines AND (^) and OR (^OR):

Filter out all competitors whose domains contain "modа" or "kupi" words with similarity above 40
The filter: nameLIKEmoda^ORnameLIKEkupi^perc>40
Request parameters: filter=nameLIKEmoda%5EORnameLIKEkupi%5Eperc%3E50
Structure of a JSON response

Most reports (unless specified otherwise) contain the standard response structure:

Field Type Description

current_page

integer

Sequential number of a results page

per_page

integer

Number of results on one page

last_page

integer

Number of the last page

total

integer

Total number of results

data

array

Array of objects that contain a result

Response example:

            {"current_page":1,"per_page":25,"last_page":29296,"data":[{}],"total":732392}
        
Server response codes
HTTP Code Description
200 Request successful
202 Request accepted from processing but not yet completed. Try again later.
401 Authorization error
429 Query limit for the current pricing plan was reached. Error details are available in the message field.
The Retry-After header of a server response specified time (in seconds) for which a client is recommended to wait before trying again.
500 Internal server error. Error details are available in the message field
Use example
  1. <?php
  2.  
  3. /*
  4.  * Example of PHP script, with use cURL lib
  5.  *
  6.  */
  7.  
  8. $url = "https://api.keys.so/report/simple/context/concurents?base=msk&domain=foodband.ru&sort=cnt%7Cdesc&page=1&per_page=250";
  9. $curl = curl_init();
  10. $headers = array('X-Keyso-TOKEN: 5a2a5f0e538dd5.6691914852255446e23a9bcac46ee5255625f5d5');
  11. curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
  12. curl_setopt($curl, CURLOPT_URL, $url);
  13. curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  14. curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
  15. curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  16. curl_setopt($curl, CURLOPT_HEADER, true);
  17. curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 15);
  18. curl_setopt($curl, CURLOPT_TIMEOUT, 15);
  19. $response = curl_exec($curl);
  20. $header_size = curl_getinfo($curl, CURLINFO_HEADER_SIZE);
  21. $headerCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  22. $responseBody = substr($response, $header_size);
  23. curl_close($curl);
  24.  

Description of REST API for simple requests

Domain Dashboard

GET report/simple/domain_dashboard

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Request example:

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

Response structure:

Field Type Description

name

string

Domain

moevideo

integer

Publisher identifier in Moevideo

leadia

integer

Publisher identifier in Leadia

leetero

integer

Publisher identifier in Leetero

adsenseid

string

Publisher identifier in Google Adsense

analytics

integer

Publisher identifier in Google Analytics

relapio

string

Webmaster identifier in Relap.io

parentid

integer

Parent domain name

parentName

string

Name of Parent Domain

childsCount

integer

Number of subdomains

it1

integer

Number of keywords in Top 1

it3

integer

Number of keywords in Top 3

it5

integer

Number of keywords in Top 5

it10

integer

Number of keywords in Top 10

it50

integer

Number of keywords in Top 50

topvis

integer

By visibility

topkeys

integer

By keywords reach

pagesinindex

integer

Pages in search results

vis

integer

Estimation of a number of visits per day

adtraf

integer

Rough estimation of a number of visits from PPC

adcost

integer

Rough estimation of budget for PPC

adscnt

integer

Number of ads

adkeyscnt

integer

Number of keywords in PPC

keys

array

Keywords (first 20)

concs

array

Competitors (first 20)

pages

array

Website pages (first 20)

ads

array

PPC ads (first 20)

adkeys

array

PPC website keywords (first 20)

adconcs

array

PPC competitors (first 20)

adsenseidCount

integer

Number of websites with same Google Adsense identifier

leadiaCount

integer

Number of websites with same Leadia identifier

leeteroCount

integer

Number of websites with same Leetero identifier

analyticsCount

integer

Number of websites with same Google Analytics identifier

relapioCount

integer

Number of websites with same Relap.io identifier

moevideoCount

integer

Number of websites with same Moevideo identifier

history

array

History of parameters changes

(object) keys:

Field Type Description

word

string

Keyword

ws

integer

Search Volume

wsk

integer

Exact search volume - using for Yandex databases

pos

integer

Position in a SERP

(object) concs:

Field Type Description

name

string

Domain name

count

integer

Shared keywords in a domain's keywords

adscnt

integer

Number of PPC ads

adkeyscnt

integer

Number of keywords in PPC

perc

double

% of shared keywords in a domain's keywords

vis

integer

Estimation of a number of visits per day

(object) pages:

Field Type Description

id

integer

Page ID

url

string

Page URL

it50

integer

Shared keywords in a domain's keywords

(object) ads:

Field Type Description

id

integer

Ad's ID

header

string

Ad's header

txt

string

Ad's text

links

string

Quick links in ad

facts

string

Facts in ad

keyscnt

integer

Number of keywords

(object) adkeys:

Field Type Description

word

string

Keyword

ws

integer

Search Volume

wsk

integer

Exact search volume - using for Yandex databases

pos

integer

Position in a place

gr3bid

integer

Average cost per click

(object) adconcs:

Field Type Description

name

string

Domain name

count

integer

Shared keywords in a domain's keywords

adscnt

integer

Number of PPC ads

adkeyscnt

integer

Number of keywords in PPC

perc

double

% of shared keywords in a domain's keywords

vis

integer

Estimation of a number of visits per day

(array) history:

array( ...,
"Update date", "топ 1", "топ 3", "топ 5", "топ 10", "топ 50", "Number of a website's pages",
... )

Response example:

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

GET report/simple/keyword_dashboard

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

keyword

string

true

search keyword

none

Request example:

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

Response structure:

Field Type Description

id

integer

Keyword ID

word

string

Keyword

ws

integer

Search Volume

wsk

integer

Exact search volume - using for Yandex databases

top

array

SEO

ads

object(key: type, value: array)

PPC

Where type:

  • pr - Top place
  • gr - Bottom place

similar

array

Similar keywords (first 20)

(object) top:

Field Type Description

pos

integer

Position

domain

string

Domain name

url

string

Page url

it1, it3, it5, it10, it50

integer

Number of domain's keywords in Top 1..Top 50

pit1, pit5, pit10, pit50

integer

Number of page's keywords in Top 1..Top 50

adsenseid

string

Publisher identifier in Google Adsense

analytics

integer

Identifier in Google Analytics

pagesinindex

integer

Number of a website's pages found in search results

vis

integer

Estimation of a number of visits per day

(object) ads:

Field Type Description

pos

integer

Position

domain

string

Domain name

header

string

Ad's header

txt

string

Ad's text

links

array

Fast links in ad

facts

array

Facts in ad

adscnt

integer

Number of PPC ads

adkeyscnt

integer

Number of keywords in PPC

(object) similar:

Field Type Description

word

string

Keyword

cnt

integer

How similar a keyword is to its original keyword

ws

integer

Search Volume

wsk

integer

Exact search volume - using for Yandex databases

docs

integer

Displays how many documents were in search results

pr0amn

integer

Average cost per click

pr0ctr

double

Expected CTR in PPC

Response example:

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

GET report/simple/context/keywords

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

header

string

Ad's header

true

txt

string

Ad's text

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

pos

integer

Position in block

true

sr

integer

Ad place

Available places:

  • 1 - top block
  • 0 - bottom block

true

numwords

integer

Number of words in a keyword

true

adscnt

integer

Number of PPC ads

true

docs

integer

Displays how many documents were in search results

true

avbid

integer

Average cost per click.

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

GET report/simple/context/keywords/byads

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

ads_id

integer

true

Ad identifier

Available in PPC "ads" report

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

header

string

Ad's header

true

txt

string

Ad's text

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

pos

integer

Position in placement

true

sr

integer

Placement

Available places:

  • 1 - top block
  • 0 - bottom block

true

numwords

integer

Number of words in a keyword

true

adscnt

integer

Number of PPC ads

true

docs

integer

Displays how many documents were in search results

true

avbid

integer

Average cost per click.

true

docs

integer

Displays how many documents were in search results

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

GET report/simple/context/ads

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

full

boolean

false

If true, keyword array for each ad will be included in a report

false

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

id

integer

Ad ID

false

header

string

Ad's header

true

txt

string

Ad's text

true

links

array

Fast links array

true

facts

array

Facts array

true

keyscnt

integer

Number of keywords

true

keys

array

Keywords of an ad, available if parameter full provided

false

Response example:

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

GET report/simple/context/ads/links

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

links

string

Unique fast links

true

Response example:

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

GET report/simple/context/ads/facts

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

links

string

Unique links

true

Response example:

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

GET report/simple/context/concurents

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

name

string

Domain name

true

perc

double

% of shared keywords in a domain's keywords

true

theme

double

% of domain keywords in a analyzed domain's keywords

true

cnt

integer

Shared keywords in a domain's keywords

true

it1

integer

Number of keywords in Top 1

true

it3

integer

Number of keywords in Top 3

true

it5

integer

Number of keywords in Top 5

true

it10

integer

Number of keywords in Top 10

true

it50

integer

Number of keywords in Top 50

true

pagesinindex

integer

Number of a website's pages found in search results

true

adsenseid

string

Publisher identifier in Google Adsense

false

analytics

integer

Identifier in Google Analytics

false

relapio

string

Webmaster identifier in Relap.io

false

vis

integer

Estimation of a number of visits per day

false

adscnt

integer

Number of PPC ads

true

adkeyscnt

integer

Number of keywords in PPC

true

adtraf

integer

Rough estimation of a number of visits from PPC

false

adcost

integer

Rough estimation of budget for PPC

false

moevideo

integer

Publisher identifier in MoeVideo

false

leadia

integer

Publisher identifier in Leadia

false

leetero

integer

Publisher identifier in Leetero

false

Response example:

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

GET report/simple/organic/keywords

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

url

string

Page url

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

pos

integer

Position in SERP

true

numwords

integer

Number of words in a keyword

true

adscnt

integer

Number of PPC ads

true

docs

integer

Displays how many documents were in search results

true

avbid

integer

Average cost per click.

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

GET report/simple/organic/sitepages

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

url

string

Page URL

true

it1

integer

Number of keywords in Top 1

true

it3

integer

Number of keywords in Top 3

true

it5

integer

Number of keywords in Top 5

true

it10

integer

Number of keywords in Top 10

true

it50

integer

Number of keywords in Top 50

true

vis

integer

Evaluation of the page's visibility in search results The higher this value, the greater is the number of potential visits to this page

true

Response example:

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

GET report/simple/organic/keywords/bypage

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

page_url

string

true

Page URL

Available in "SEO pages" and "SEO keywords" reports

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

pos

integer

Position in SERP

true

numwords

integer

Number of words in a keyword

true

adscnt

integer

Number of PPC ads

true

docs

integer

Displays how many documents were in search results

true

avbid

integer

Average cost per click.

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

GET report/simple/organic/concurents

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

name

string

Domain name

true

perc

double

% of shared keywords in a domain's keywords

true

theme

double

% of domain keywords in a analyzed domain's keywords

true

cnt

integer

Shared keywords in a domain's keywords

true

it1

integer

Number of keywords in Top 1

true

it3

integer

Number of keywords in Top 3

true

it5

integer

Number of keywords in Top 5

true

it10

integer

Number of keywords in Top 10

true

it50

integer

Number of keywords in Top 50

true

pagesinindex

integer

Number of a website's pages found in search results

true

adsenseid

string

Publisher identifier in Google Adsense

false

analytics

integer

Identifier in Google Analytics

false

relapio

string

Webmaster identifier in Relap.io

false

vis

integer

Estimation of a number of visits per day

false

adscnt

integer

Number of PPC ads

true

adkeyscnt

integer

Number of keywords in PPC

true

adtraf

integer

Rough estimation of a number of visits from PPC

false

adcost

integer

Rough estimation of budget for PPC

false

moevideo

integer

Publisher identifier in MoeVideo

false

leadia

integer

Publisher identifier in Leadia

false

leetero

integer

Publisher identifier in Leetero

false

Response example:

        
SEO: Competitors of the website's page

GET report/simple/organic/concurent_pages

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

domain

string

true

Domain name

none

page_url

string

true

Page URL

Available in "SEO pages" and "SEO keywords" reports

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

report/simple/organic/concurent_pages?base=msk&domain=wildberries.ru&page_url=%2Fbrands%2Fadidas&sort=pos%7Casc&page=1&per_page=25

Response structure:

Field Type Description Filter

domain

string

Domain name

true

url

string

Page displayed in search results

true

perc

double

% of shared keywords in a page's keywords

true

theme

double

% of source page's keywords in a page's keywords

true

cnt

integer

Shared keywords in a domain's keywords

true

it1

integer

Number of keywords in Top 1

true

it3

integer

Number of keywords in Top 3

true

it5

integer

Number of keywords in Top 5

true

it10

integer

Number of keywords in Top 10

true

it50

integer

Number of keywords in Top 50

true

Response example:

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

GET report/simple/similarkeys

Request parameters:

Parameter Type Mandatory Description Default value

base

string

true

Regional database, from which samples are being taken

Possible values:

  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan
  • alm - Yandex: Almaty

none

keyword

string

true

search keyword

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

cnt

integer

How similar a keyword is to its original keyword

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

docs

integer

Displays how many documents were in search results

true

avbid

integer

Average cost per click

true

Response example:

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

GET report/owner/{mode}

Available values {mode}:

  • analytics - search by Google Analytics identifier
  • adsense - search by Google Adsense identifier
  • leadia - search by Leadia identifier
  • moevideo - search by Moevideo identifier
  • leetero - search by Leetero identifier
  • relapio - search by Relap.io identifier
  • subdomains - search for subdomains

Request parameters:

Parameter Type Mandatory Description Default value

id

string

true

Depending on {mode}:

  • analytics - Google Analytics identifier
  • adsense - Google Adsense identifier
  • leadia - Leadia identifier
  • relapio - Relap.io identifier
  • subdomains - domain name

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

report/owner/subdomains?id=wildberries.ru&sort=name%7Casc&page=1&per_page=25

report/owner/analytics?id=27827341&sort=name%7Casc&page=1&per_page=25

report/owner/relapio?id=TEI7T7IxrnrKms&sort=name%7Casc&page=1&per_page=25

Response structure:

Field Type Description Filter

name

string

Domain name

true

it1

integer

Number of keywords in Top 1

true

it3

integer

Number of keywords in Top 3

true

it5

integer

Number of keywords in Top 5

true

it10

integer

Number of keywords in Top 10

true

it50

integer

Number of keywords in Top 50

true

pagesinindex

integer

Number of a website's pages found in search results

true

adsenseid

string

Publisher identifier in Google Adsense

false

analytics

integer

Identifier in Google Analytics

false

relapio

string

Webmaster identifier in Relap.io

false

vis

integer

Estimation of a number of visits per day

false

adscnt

integer

Number of PPC ads

true

adkeyscnt

integer

Number of keywords in PPC

true

adtraf

integer

Rough estimation of a number of visits from PPC

false

adcost

integer

Rough estimation of budget for PPC

false

moevideo

integer

Publisher identifier in MoeVideo

false

leadia

integer

Publisher identifier in Leadia

false

leetero

integer

Publisher identifier in Leetero

false

Response example:

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

GET report/keywords

Request parameters:

Parameter Type Mandatory Description Default value
Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

report/keywords?sort=wsk%7Casc&page=1&per_page=25

Response structure:

Field Type Description Filter

word

string

Keyword

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

numwords

integer

Number of words in a keyword

true

adscnt

integer

Number of PPC ads

true

docs

integer

Displays how many documents were in search results

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

Documentation of group report's f REST API

Create group report

POST report/group/create

Request body:

Field name Type Required Description

base

String

true

Database name

Available values:

  • gus - Google: USA
  • msk - Yandex: Moscow
  • gru - Google: Moscow
  • spb - Yandex: St. Petersburg
  • ekb - Yandex: Ekaterinburg
  • krr - Yandex: Krasnodar
  • nnv - Yandex: N. Novgorod
  • rnd - Yandex: Rostov-on-Don
  • yua - Yandex: Kiev
  • mns - Yandex: Minsk
  • kzn - Yandex: Kazan
  • tlt - Yandex: Togliatti
  • oms - Yandex: Omsk
  • vlg - Yandex: Volgograd
  • nsk - Yandex: Novosibirsk
  • che - Yandex: Chelyabinsk
  • sam - Yandex: Samara
  • ufa - Yandex: Ufa
  • kry - Yandex: Krasnoyarsk
  • prm - Yandex: Perm
  • vrn - Yandex: Voronezh
  • sar - Yandex: Saratov
  • tmn - Yandex: Tyumen
  • ast - Yandex: Nur-Sultan

domains

array

true

Domains array in report

name

String

false

Report name

Request example:

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

Response structure:

Field Type Description

rid

string

Report ID

Response example:

            {"rid":"696b62ec6bceaf00529c4dd4bce02b47"}
        
SEO - keywords

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

word

string

Keyword

true

weight

integer

Keyword's importance in the report

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

numwords

integer

Number of words a in keyword

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response example:

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

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

Request example:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

name

string

Domain name

true

perc

double

Similarity (Percentage of shared keys among a domain's keys)

true

cnt

integer

Shared

true

it1

integer

Number of keywords for which the page ranks first in search results

true

it3

integer

Number of keywords for which the page holds positions from 1 to 3

true

it5

integer

Number of keywords for which the page holds positions from 1 to 5

true

it10

integer

Number of keywords for which the page holds positions from 1 to 10

true

it50

integer

Number of keywords for which the page holds positions from 1 to 50

true

pagesinindex

integer

Pages in index

true

adsenseid

string

If we've found markers of Google Adsense advertising network on a website's pages, this field will specify its numeric publisher identifier.

false

analytics

integer

A marker of Google Analytics statistical service, if any was found.

false

relapio

string

Publisher marker of Relap.io system.

false

vis

integer

We calculate the "website visibility" parameter, and on the basis of this parameter we attempt to predict how much visits a website gets due to searches

false

adscnt

integer

Number of PPC ads advertising this domain

true

adkeyscnt

integer

Number of keywords for which a PPC ad from this website was displayed in search results

true

adtraf

integer

false

adcost

integer

false

rsya

integer

Whether code from Yandex Advertising Network was found when examining this website.

false

moevideo

integer

Publisher marker of MoeVideo system

false

leadia

integer

Publisher marker of Leadia system

false

leetero

integer

Publisher marker of Leetero system

false

Response example:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

pid

integer

Page ID

false

domain

string

Domain name

true

url

string

Page url

true

it1

integer

Number of keywords for which the page ranks first in search results

true

it3

integer

Number of keywords for which the page holds positions from 1 to 3

true

it5

integer

Number of keywords for which the page holds positions from 1 to 5

true

it10

integer

Number of keywords for which the page holds positions from 1 to 10

true

it50

integer

Number of keywords for which the page holds positions from 1 to 50

true

vis

integer

We calculate the "website visibility" parameter, and on the basis of this parameter we attempt to predict how much visits a website gets due to searches

true

Response example:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

report/group/context/keywords/696b62ec6bceaf00529c4dd4bce02b47?sort=weight%7Cdesc&page=1&per_page=25

Response structure:

Field Type Description Filter

weight

integer

Keyword's importance in the report

true

ws

integer

Search Volume

true

wsk

integer

Exact search volume - using for Yandex databases

true

s0amn

integer

PPC bid

true

s0ctr

double

PPC CTR

true

gamn

integer

PPC bid

true

gctr

double

PPC CTR

true

numwords

integer

Number of words a in keyword

true

adscnt

integer

Number of PPC ads advertising this domain

true

isgeo

integer

Is a place-name

true

isquest

integer

Is a question

true

Response structure:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

report/group/context/concurents/696b62ec6bceaf00529c4dd4bce02b47?sort=cnt%7Cdesc&page=1&per_page=25

Response structure:

Field Type Description Filter

name

string

Domain name

true

perc

double

Similarity (Percentage of shared keys among a domain's keys)

true

cnt

integer

Shared

true

it1

integer

Number of keywords for which the page ranks first in search results

true

it3

integer

Number of keywords for which the page holds positions from 1 to 3

true

it5

integer

Number of keywords for which the page holds positions from 1 to 5

true

it10

integer

Number of keywords for which the page holds positions from 1 to 10

true

it50

integer

Number of keywords for which the page holds positions from 1 to 50

true

pagesinindex

integer

Pages in index

true

adsenseid

string

If we've found markers of Google Adsense advertising network on a website's pages, this field will specify its numeric publisher identifier.

false

analytics

integer

A marker of Google Analytics statistical service, if any was found.

false

relapio

string

Publisher marker of Relap.io system.

false

vis

integer

We calculate the "website visibility" parameter, and on the basis of this parameter we attempt to predict how much visits a website gets due to searches

false

adscnt

integer

Number of PPC ads advertising this domain

true

adkeyscnt

integer

Number of keywords for which a PPC ad from this website was displayed in search results

true

adtraf

integer

false

adcost

integer

false

rsya

integer

Whether code from Yandex Advertising Network was found when examining this website.

false

moevideo

integer

Publisher marker of MoeVideo system

false

leadia

integer

Publisher marker of Leadia system

false

leetero

integer

Publisher marker of Leetero system

false

Response example:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

aid

integer

Unique Ad ID

false

domain

string

Domain name

true

header

string

First row of an ad – its header (or header + header 2, if both fields were filled in for the ad)

true

txt

string

Ad text itself

true

links

array

A list of quick link texts specified for an ad

true

facts

array

A list of facts specified for an ad

true

keyscnt

integer

Number of keywords

true

Response example:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

links

string

Unique Links

true

Response example:

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

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

Request parameters:

Parameter Type Mandatory Description Default value

rid

string

true

Report identifier

none

Standard keyword parameters

page

integer

false

Sequence number of a results page

1

per_page

integer

false

Number of results on one page

50 000

sort

string

false

Data sorting by fields

Format: field|direction, where

  • field - column name
  • direction - sorting order, asc - ascending, desc - descending

Value example:

pos|asc

Value example for sorting by two fields:

pos|asc,wsk|desc

none

filter

string

false

Details about filtering you can find in the API description - Data filtering section

none

Request example:

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

Response structure:

Field Type Description Filter

links

string

Unique Facts

true

Response example:

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