Сортировка данных


Параметры POST одинаковы для всех сортировок. Исключение составляет сортировка по меткам, где добавляется параметр keywords_tag, обозначающий цвет метки.

Действие Параметры GET Параметры POST Ответ
Сортировка запросов по алфавиту, по частоте, по целевой ссылке, по релевантной ссылке &module=mod_keywords
&func=history
project_id, competitor_id, group_id, region_lang, date1, date2, searcher, region_key, region_device, type_range, max_pos, min_pos, sort_by_type, offset, rows {
total,
phrases,
all_dates,
is_empty,
compare,
scheme
}
Сортировка запросов по меткам &module=mod_keywords
&func=history
project_id, competitor_id, group_id, region_lang, date1, date2, searcher, region_key, region_device, type_range, max_pos, min_pos, keywords_tag, offset, rows {
total,
phrases,
all_dates,
is_empty,
compare,
scheme
}

Описание параметров POST:

  • project_id – ID проекта;
  • competitor_id – ID конкурента, ("-2" - сравнение по конкурентам);
  • group_id – ID группы запросов ("-1" – все группы);
  • region_lang – код языка выдачи (по умолчанию "ru");
  • date1 – с даты (международный формат YYYY-MM-DD);
  • date2 – по дату (международный формат YYYY-MM-DD);
  • searcher – выбранная ПС:
    • 0 - Yandex, домен определяется по региону;
    • 1 - Google, домен определяется по региону;
    • 2 - Mail
    • 3 - Спутник
    • 4 - Youtube
    • 5 - Bing
    • 6 - Yahoo
    • -2 - Cравнение по поисковикам
  • region_key – номер региона (номер региона общей выдачи "-1", сравнение по регионам "-2");
  • region_device – тип устройства:
    • 0 - ПК
    • 1 - планшет
    • 2 - смартфон
  • type_range – по умолчанию 3:
    • 1 – только дни апдейтов Yandex
    • 2 – весь период (не более 30 дней)
    • 3 – две даты
    • 4 – один день
    • 5 – последняя дата каждого месяца
  • max_pos – верхняя граница ТОПа;
  • min_pos – нижняя граница ТОПа;
  • rows – количество возвращзаемых фраз;
  • offset – сдвиг;
  • sort_by_type – тип сортировки:
    • 1|1| - по алфавиту от А до Я
    • 1|0| - по алфавиту от Я до А
    • 2|0|1 - по убыванию частоты
    • 2|1|1 - по возрастанию частоты
    • Третья цифра в значении параметра означает тип частоты. Для ПС Яндекс:
      1 - Частота
      2 - "Частота"
      3 - "!Частота"
      5 - "[Частота]"
      6 - "[!Частота]"
      Для ПС Google:
      3 - [Частота]
    • 6|0| - по целевой ссылке
    • 7|0|ГГГГ-ММ-ДД - по релевантной ссылке
  • keywords_tag – цвет метки:
    • 0 - без метки
    • 1 - красный
    • 2 - оранжевый
    • 3 - желтый
    • 4 - синий
    • 5 - фиолетовый
    • 6 - зеленый
    • 7 - маджента
    • 8 - темно-синий
    • 9 - бирюзовый

Описание ответа:

  • total – общее количество запросов;
  • phrases – массив объектов запросов;
  • all_dates – список дат, проверенных по указанным региону и ПС;
  • is_empty – наличие проверок за выбранный период;
  • compare – режим сравнения:
    • regions – по регионам
    • competitors – по конкурентам
    • searchers – по поисковым системам
  • scheme – информация о поисковых системах (searchers), регионах (regions), языке (lang), типе устройства (device);

Отсортировать запросы проекта XXX по убыванию частоты в период с 25 июля 2016 по 4 августа 2016 года (регион Санкт-петербург, Яндекс):
https://api.topvisor.ru/?api_key=Ваш_Ключ&module=mod_keywords&func=history
&post[project_id]=XXX&post[searcher]=0&post[region_key]=2&post[date1]=2016-07-25&post[date2]=2016-08-04&post[sort_by_type]=2|0|1