Яндекс Wordstat. Руководство разработчика
Яндекс Wordstat - параметры, передаваемые в GET-запросе
Если вы передаете параметры через GET или POST-запрос, то они имеют приоритет над настройками по умолчанию в личном кабинете. Если какой-либо из параметров не передается, то его значение берется из настроек по умолчанию.
https://xmlstock.com/wordstat/json/
? [user=<ID пользователя>]
& [key=<API-ключ>]
& [query=<текст поискового запроса>]
& [pagetype=<тип результатов>]
& [groupby=<количество фраз>]
& [period=<способ группировки>]
& [start=<начальная дата>]
& [end=<конечная дата>]
& [device=<типы устройств>]
& [distributionby=<способ распределения по регионам>]
& [regions=<идентификаторы регионов поиска>]
Перечень доступных параметров и их описание
| Параметр | Обязательно | Описание и допустимые значения |
|---|---|---|
| &user= | да | Ваш уникальный ID пользователя |
| &key= | да | Ваш уникальный API-ключ, выданный при регистрации Можно поменять в любой момент |
| &query= | да |
Текст поискового запроса &query=окна - результаты поисковой выдачи Максимальная длина запроса — 400 символов. |
| &pagetype= | нет | Тип поискового запроса, указывает какие данные необходимо выбирать: words - топ результатов по ключевой фразе (значение по умолчанию) history - динамика изменения запросов regions - распределение количества запросов по регионам в глоабльном масштабе за 30 дней regionsTree - получение списка поддерживаемых регионов |
| &groupby= | нет | Количество выводимых фраз в ответе. Допустимые значения: 1-2000 Используется только при &pagetype=words |
| &device= | нет | Список типов устройств, с которых был сделан запрос. all или пустое значение — все устройства (по умолчанию). desktop — компьютеры; mobile или phone — телефоны; tablet — планшеты; Значения можно группировать и указывать через запятую. |
| &period= | нет | Период агрегирования количества запросов. Возможные значения: month — по месяцам (значение по умолчанию), при этом start - первое число месяца, end - последнее число месяца; week — по неделям, при этом start - понедельник, end - воскресенье; day — по дням. Используется только при &pagetype=history |
| &start= | нет | Дата начала периода, для которого запрашиваются данные в формате ДД.ММ.ГГГГ. Используется только при &pagetype=history |
| &end= | нет | Дата конца периода, для которого запрашиваются данные в формате ДД.ММ.ГГГГ. Используется только при &pagetype=history |
| ®ions= | нет | Список идентификаторов регионов, из которых был сделан запрос, указываются через запятую. Для исключения региона используйте его ID со знаком минус. Максимальное количество элементов — 100. Либо ®ions=all для выбора всех регионов. Используется только при &pagetype=words и &pagetype=history |
| &distributionby= | нет | Отображать распределение запросов только по городам, только по регионам или по всему региону. all или пустое значение — все (по умолчанию). cities — по городам. regions — по регионам. Используется только при &pagetype=regions |
Параметры, передаваемые в POST-запросе
Post запросы не поддерживаются.
