Дополнительные опции

Актуальная версия API для получения истории проверки позиций.
Актуальная версия API для получения стоимости проверки позиций.
Эта версия перестанет поддерживаться 01.05.2018 года.

Действие Параметры GET Параметры POST Ответ
Получить динамику позиций запросов проекта &oper=get&module=mod_keywords
&func=history
project_id,
competitor_id,
searcher,
region_key,
region_lang,
region_device,
group_id,
date1,
date2,
type_range,
max_pos,
min_pos,
offset,
history_view,
limit
{
total,
phrases,
all_dates,
is_empty,
compare,
scheme
}
Получить динамику позиций запроса по его названию &oper=get&module=mod_keywords
&func=history
project_id, searcher, region_key, date1, date2, type_range, phrase {
total,
phrases,
all_dates,
is_empty,
compare,
scheme
}
Установить целевую страницу &oper=edit&module=mod_keywords
&func=targets
project_id, target, group_id, id {result, message, error}
Получить гостевую ссылку &module=mod_keywords
&func=history_link
project_id, competitor_id, searcher, region_key, region_lang, region_device, group_id, date1, date2, type_range, max_pos, min_pos [Гостевая ссылка]
Удалить проверку &oper=del&module=mod_keywords
&func=history
date, id {result, message, error}
Статус проверки позиций &module=mod_keywords
&func=percent_of_parse
project_ids[] [{id, percent},…]
Цена проверки по всему ядру &module=mod_keywords
&func=parse_price
search_json, apply_discount {id, user, name, count_tasks, price, xml_for_use}
Цена проверки по фильтру &module=mod_keywords
&func=parse_price
search_json, searcher, region_key, region_lang, region_device, group_id, apply_discount {id, user, name, count_tasks, price, xml_for_use}

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

  • project_id – ID проекта;
  • competitor_id – ID конкурента, ("-2" - сравнение по конкурентам);
  • searcher – выбранная ПС:
    • 0 - Yandex, домен определяется по региону
    • 1 - Google, домен определяется по региону
    • 2 - Mail
    • 3 - Спутник
    • 4 - Youtube
    • 5 - Bing
    • 6 - Yahoo
    • -2 - Cравнение по поисковикам
  • region_key – номер региона (номер региона общей выдачи "-1", сравнение по регионам "-2");
  • region_lang – код языка выдачи (по умолчанию "ru");
  • region_device – тип устройства:
    • 0 - ПК
    • 1 - планшет
    • 2 - смартфон
  • group_id – id группы запросов ("-1" – все группы) ;
  • date1 – с даты (международный формат YYYY-MM-DD);
  • date2 – по дату (международный формат YYYY-MM-DD);
  • phrase – запрос;
  • type_range – по умолчанию 3:
    • 1 – только дни апдейтов Yandex
    • 2 – весь период (не более 30 дней)
    • 3 – две даты
    • 4 – один день
    • 5 – последняя дата каждого месяца
    • 100 – произвольные даты
  • max_pos – верхняя граница ТОПа;
  • min_pos – нижняя граница ТОПа;
  • offset – сдвиг;
  • history_view – режим отображения:
    • 1 – режим Позиции
    • 2 – режим Позиции и Сниппеты
  • limit – количество возвращаемых фраз;
  • target – целевая ссылка;
  • id – ID проекта, ID запроса;
  • date – дата (международный формат YYYY-MM-DD);
  • project_ids[] – массив ID проектов;
  • dates[] – массив дат (используется для получения динамики позиций произвольных дат, когда параметр type_range=100);
  • search_json – закодированная строка в формате json;
  • apply_discount – цена проверки:
    • 1 – с учётом скидки
    • 0 – без учёта скидки

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

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

Примечание: Дате scheme[dates][0][date] соответствуют данные, находящиеся в массиве phrases[0,1,2....][0][dates][0]

Просмотр динамики по запросам проекта XXX ПС Yandex региона Санкт-Петербург по всем группам
запросов с 11 по 15 октября 2013г.:

https://api.topvisor.ru/?api_key=Ваш_Ключ&oper=get&module=mod_keywords&func=history&post[project_id]=XXX &post[limit]=20&post[page]=1&post[searcher]=0&post[region_key]=2&post[group_id]=-1
&post[date1]=2013-10-11 &post[date2]=2013-10-15&post[type_range]=2

Просмотр динамики позиций запроса "пластиковые окна" проекта XXX в ПС Яндекс в регионе
Санкт-Петербург с 11 по 15 октября 2013г.:

https://api.topvisor.ru/?api_key=Ваш_Ключ&module=mod_keywords&oper=get&func=history&post[project_id]=XXX&post[searcher]=0&post[region_key]=2&post[date1]=2013-10-11&post[date2]=2013-10-15
&post[type_range]=2&post[phrase]=плластиковые окна

Назначить целевую ссылку группе запросов X проекта XXX:
https://api.topvisor.ru/?api_key=Ваш_Ключ&oper=edit&module=mod_keywords&func=targets
&post[project_id]=XXX&post[group_id]=X& post[id]=XXX&post[target]=URL_целевой_страницы

Получить гостевую ссылку для предоставления доступа к просмотру позиций проекта XXX в период с 4 августа 2016 по 14 августа 2016 года по региону Санкт-Петербург и ПС Яндекс :
https://api.topvisor.ru/?api_key=Ваш_Ключ&module=mod_keywords&func=history_link &post[project_id]=XXX&post[competitor_id]=XXX&post[searcher]=0&post[region_key]=2&post[group_id]=X
&post[region_device]=0&post[region_lang]=ru&post[date1]=2016-08-04&post[date2]=2016-08-14
&post[type_range]=2&post[max_pos]=&post[min_pos]=&post[history_view]=1

Удалить проверку за 4 августа 2016 года в проекте XXX:
https://api.topvisor.ru/?api_key=Ваш_Ключ&oper=del&module=mod_keywords&func=history
&post[date]=2016-08-04&post[id]=XXX

Проверить статус проверки позиций проектов XXX1 и XXX2:
https://api.topvisor.ru/?api_key=Ваш_Ключ&oper=get&module=mod_keywords&func=percent_of_parse
&post[project_ids][]=XXX1&post[project_ids][]=XXX2

Удалить запрос в проекте XXX:
https://api.topvisor.ru/?api_key=Ваш_Ключ&oper=del&module=mod_keywords
&post[id]=ID_запроса&post[project_id]=XXX

Узнать цену проверки проекта XXX по всему ядру запросов:
https://api.topvisor.ru/?api_key=Ваш_Ключ&module=mod_keywords&func=parse_price
&post[search_json]={"id":XXX}&post[apply_discount]=1

Узнать цену проверки группы X проекта XXX в ПС Яндекс в регионе Санкт-Петербург:
https://api.topvisor.ru/?api_key=Ваш_Ключ&module=mod_keywords&func=parse_price
&post[search_json]={"id":XXX}&post[searcher]=0&post[region_key]=2&post[group_id]=X&post[region_device]=0&post[region_lang]=ru&post[apply_discount]=1

Обратите внимание, что запрашивать данные о динамике следует только по регионам и ПС, указанным в настройках проекта. Иначе результаты получены не будут.

Получение нуля в массиве результата ([0]) свидетельствует о попытке получить данные чужого проекта.