Skip to main content

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

Метод History возвращает историю запросов из Yandex Wordstat по исходному запросу.

Чтобы получить историю запросов, необходимо выполнить POST-запрос на адрес https://moab-apis.ru/api/v1/wordstat/history с заголовком X-Api-Key и телом запроса в виде следующего JSON-объекта:

{
  "query": "Купить",
  "region": "225",
  "device": "All",
  "grouping": "Month",
  "start_date": null,
  "end_date": null
}

Параметры query, region и device имеют такое же назначение, как и описанные в методе Frequency. Однако, здесь добавляется еще один параметр grouping, который отвечает за период группировки и может принимать значения:

  • Day – группировка по дням
  • Week – группировка по неделям
  • Month – группировка по месяцам

Коды ответов аналогичны кодам, возвращаемым в разделе Region, не будем останавливаться на этом подробнее.

Также в запрос можно передать даты, по которым будут ограничены данные, возвращаемые за указанный период:

  • start_date (Nullable) – дата начала периода (в формате YYYY-DD-MM)

  • end_date (Nullable) – дата окончания периода (в формате YYYY-DD-MM)

Если даты указать как null – вернутся все значения, возвращаемые Wordstat’ом по умолчанию.

К указанию дат применяются определенные требования:

  • При указании группировки Day: Максимальный период: 60 дней. Минимальный период: 3 дня. Считаем от вчерашнего дня

  • При указании группировки Week: Максимальный период: 7 лет с учетом календарной недели. Минимальный 3 календарные недели

  • При указании группировки Month: Максимальный период: 7 лет с учетом полного календарного месяца. Минимальный 3 полных календарных месяца

Даты в группировках Week и Month необходимо указывать строго как начало/конец искомого периода 

  • для группировки Week start_date должен быть всегда понедельником, end_date – воскресеньем

  • для группировки Month start_date должен быть всегда первым числом месяца, end_date – последним

При несоблюдении этих требований будет возвращена стандартная ошибка с пояснениями в поле invalid_data.

Если запрос выполнен успешно, в ответ вы получите HTTP-код 200 и JSON-ответ вида:

{
  "items": [
    {
      "date": "2025-07-01",
      "frequency": 163857055,
      "all_requests_percentage": 1.67
    },
    {
      "date": "2025-08-01",
      "frequency": 160182297,
      "all_requests_percentage": 1.66
    },
    {
      "date": "2025-09-01",
      "frequency": 156048613,
      "all_requests_percentage": 1.45
    }
  ]
}

В ответе возвращается массив items, который содержит в себе исторические данные частоты по запросу в выбранном периоде группировки. frequency в этом массиве означает абсолютную частоту, all_requests_percentage – относительную.

Back to top