get/snapshots_2/history

Описание метода

Получает снимок поисковой выдачи.

Метод не работает с архивными проектами.

Параметры метода

Параметр Тип Описание По умолчанию
Обязательные
project_id int ID проекта
region_index int Индекс региона
dates array of date Произвольные даты проверок
(dates является обязательным, если date1 и date2 не указаны)
date1, date2 date Крайние даты периода
filters array filters
of keywords
Критерий фильтрации объекта "Ключевая фраза" (не более 100 штук за запрос)
Дополнительные
type_range enum(0, 1, 2, 3, 4, 5, 6, 7, 100)

Период дат

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

Возможные значения:

  • 0 - весь период без ограничений
  • 1 - только апдейты
  • 2 - период до 31 даты
  • 3 - две даты
  • 4 - одна дата
  • 5 - последняя дата каждого месяца
  • 6 - даты через равные промежутки
  • 7 - две последние даты проверок
  • 100 - произвольные даты (иcпользуется только с параметром dates)
3
count_dates int Максмальное число возвращаемых дат (не более 31) 31
show_exists_dates boolean Добавить в результат даты, в которых были проверки 0
show_ams boolean Добавить в результат показатель шторма между выбранными проверками 0
positions_fields array('url', 'domain', 'snippet_title', 'snippet_body')

Выбор столбцов данных с результатами проверки:

  • url - страница сайта
  • domain - домен сайта
  • snippet_title - заголовок сниппета
  • snippet_body - описание сниппета

Посмотреть в API Explorer

Возвращаемые данные

Параметр Тип Описание
result (объект)
keywords array of keywords Отчет по ключевым фразам и другие поля ключевых фраз
keywords.snapshotsData object (определитель => object) Данные по проверке
keywords.amsData object(определитель => object) Данные по шторму по каждой проверке по указанным запросам (если show_ams = 1)
depthPositions int

Глубина выполненных снимков:

  • 20 - ТОП20
  • 30 - ТОП30
  • 50 - ТОП50
  • 100 - ТОП100
dates array(date) Даты проверок
existsDates array(date) Даты, в которых были проверки (если show_exists_dates = 1)
result.keywords[N].snapshotsData[date:position:regionIndex]
url string Страница сайта
domain string Домен сайта
snippet_title string Заголовок сниппета
snippet_body string Описание сниппета
result.keywords[N].amsData[date:regionIndex]
am int Значение шторма (от 0 до 10)
compare_date date Дата проверки, относительно которой считается шторм