Яндекс Wordstat — формат запроса
Для получения данных Яндекс Wordstat необходимо сформировать GET-запрос к персональному URL инструмента.
Результаты возвращаются только в формате JSON. Форматы XML и HTML не поддерживаются.
Формирование базового запроса
Добавьте к персональному URL параметр query со словом или словосочетанием, для которого требуется получить статистику.
Например:
Если тип статистики не указан в URL, используется значение, сохранённое в настройках инструмента. По умолчанию возвращается топ запросов по ключевой фразе.
Типы получаемых данных
Тип статистики определяется параметром pagetype.
Топ запросов
Для получения популярных запросов, содержащих заданное слово или словосочетание, используйте параметр: &pagetype=words
Например:
В ответе возвращаются популярные запросы за последние 30 дней и похожие запросы пользователей.
Динамика запросов
Для получения изменения частотности за выбранный период используйте: &pagetype=history
Например:
Для динамики необходимо указать период анализа и способ группировки данных: по дням, неделям или месяцам.
Распределение по регионам
Для получения распределения количества запросов по регионам за последние 30 дней используйте: &pagetype=regions
Например:
Результаты можно получать по всем доступным территориям, только по регионам или только по городам.
Обратите внимание: запрос распределения по регионам тарифицируется отдельно и имеет более высокую стоимость, чем получение топа запросов или динамики частотности. Актуальная цена отображается в настройках инструмента и на странице Тарифные планы.
Список поддерживаемых регионов
Для получения дерева регионов и их идентификаторов используйте: &pagetype=regionsTree
Например:
Для этого типа запроса параметр query не требуется. Полученные идентификаторы можно использовать в других запросах Wordstat.
Настройки и параметры URL
Параметры, переданные непосредственно в URL, имеют приоритет над настройками, сохранёнными в личном кабинете.
Если необязательный параметр не передан, используется его значение из настроек инструмента.
Полный перечень параметров, допустимых значений и ограничений представлен в разделе Таблица параметров.
Операторы Wordstat
В параметре query поддерживаются основные операторы Яндекс Wordstat. Их назначение соответствует веб-версии сервиса.
| Оператор | Назначение | Пример |
|---|---|---|
" " |
Фиксирует количество слов без дополнительных слов | "купить телефон" |
! |
Фиксирует грамматическую форму слова | !купить !телефон |
+ |
Делает предлог или другое стоп-слово обязательным | работа +в москве |
- |
Исключает запросы с указанным словом | ремонт квартиры -самостоятельно |
[ ] |
Фиксирует порядок слов | билеты [из москвы в париж] |
| и ( ) |
Объединяет несколько вариантов через условие «или» | купить (телефон|смартфон) |
Операторы можно комбинировать. Например: "!купить !телефон"
Такой запрос исключает дополнительные слова и фиксирует формы обоих слов.
Кодирование запроса
Поисковую фразу, включая операторы, необходимо передавать в корректной URL-кодировке.
Пример на PHP:
$url = 'https://xmlstock.com/wordstat/json/'
. '?user=USER_ID'
. '&key=API_KEY'
. '&pagetype=words'
. '&query=' . urlencode('"!купить !телефон"');Структура возвращаемых данных описана в разделе Формат ответа.
Возможные ошибки и требования к значениям параметров представлены в разделе Коды ошибок.
