get/positions_2/summary/chart

Возвращает координаты различных показателей для графика с осями: Дата/Величина показателя.

Доступны 3 графика:

  • Дата/Срезы ТОПа (несколько значений, по одному на каждый срез ТОПа)
  • Дата/Видимость
  • Дата/Средняя позиция

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

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

Период дат

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

  • 0 - весь период без ограничений
  • 1 - только апдейты
  • 2 - период до 31 даты
  • 3 - две даты
  • 4 - одна дата
  • 5 - последняя дата каждого месяца
  • 6 - даты через равные промежутки
  • 7 - две последние даты проверок
  • 100 - произвольные даты (иcпользуется только с параметром dates)
2
only_exists_first_date boolean Учитывать ключевые фразы, присутствующие во всех датах 0
show_tops boolean Добавить в результат данные по ТОПам 0
show_avg boolean Добавить в результат среднюю позицию 0
show_visibility boolean Добавить в результат видимость 0

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

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

Параметр Тип Описание
result (объект)
dates array Произвольные даты (ось X)
seriesByProjectsId object Координаты, сгруппированные по id проекта
result.seriesByProjectsId.%projectId%
tops object

Количество запросов в ТОПах

Свойства объекта:

  • {NN}_{NN} - срезы ТОПа. По умолчанию возвращаются следующие срезы ТОПа:
    • 1_10 - ТОП10
    • 11_30 - ТОП11-30
    • 31_50 - ТОП31-50
    • 51_100 - ТОП51-100
    • 101_10000 - ТОП100+
  • all - сумма во всех ТОПах
avg array Значения средней позиции для дат, указанных в dates
visibility array Значения видимости для дат, указанных в dates