Актуальная версия API для просмотра сводки.
Эта версия перестанет поддерживаться 01.03.2018 года.
Данные о динамике проекта (устаревшая версия)
Действие | Параметры GET | Параметры POST | Ответ |
---|---|---|---|
Получить данные о динамике проекта за указанный промежуток времени | &oper=get&module=mod_keywords &func=history_summary |
project_id, group_id, date1, date2, searcher, region_key, region_lang | { visibility, up_visibility, avg, up_avg, count, top_percent, up_position, stay_position, down_position, count3, count10, count30, count50, count100, count10000, up3, up10, up30, up50, up100, up10000 } |
Получить данные о динамике проекта за указанный промежуток времени по датам проверок позиций | &oper=get&module=mod_keywords &func=history_summary_by_dates |
project_id, searcher, group_id, region_key, region_lang, date1, date2, type_range, graph_type | { date, avg, visibility, count3, count10, count30, count50, count100, count10000 } |
Описание параметров POST:
- project_id – ID проекта;
- group_id – ID группы запросов ("-1" – все группы);
- date1 – с даты (международный формат YYYY-MM-DD);
- date2 – по дату (международный формат YYYY-MM-DD);
- searcher – описание значений здесь;
- type_range – описание значений здесь;
- region_key – номер региона (номер региона общей выдачи "-1", сравнение по регионам "-2");
- region_lang – код языка выдачи (по умолчанию - русский "ru"); Обратите внимание, что если в настройках проекта выбран не русский язык, то необходимо обязательно указывать данный параметр.
- graph_type – показатель:
- 0 - ТОП100;
- 1 - Средняя позиция;
- 2 - Видимость
Описание ответа:
- visibility – значение показателя Видимость за указанный период времени;
- up_visibility – динамика показателя Видимость (увеличился/уменьшился);
- avg – значение показателя Средняя позиция за указанный период времени;
- up_avg – динамика показателя Средняя позиция (увеличился/уменьшился);
- count – общее количество запросов, позиции которых увеличились/не изменились/уменьшились за указанный период времени;
- top_percent – процент запросов в ТОПе за указанный период времени;
- up_position – количество запросов, позиции которых увеличились за указанный период времени;
- stay_position – количество запросов, позиции которых не изменились за указанный период времени;
- down_position – количество запросов, позиции которых уменьшились за указанный период времени;
- count3/count10/count11-30/count31-50/count51-100/count100+ – количество запросов в ТОП3/ТОП10/ТОП11-30/ТОП31-50/ТОП51-100/ТОП100+ за указанный период времени;
- up3/up10/up11-30/up31-50/up51-100/up100+ – динамика позиций в ТОП3/ТОП10/ТОП11-30/ТОП31-50/ТОП51-100/ТОП100+ за указанный период времени;
- date – дата проверки позиций;
Получить данные динамики проекта XXX в ПС Яндекс в регионе Санкт-Петербург за период
с 25 июля 2016 по 4 августа 2016 года:
https://api.topvisor.com/?api_key=Ваш_Ключ&oper=get&module=mod_keywords&func=history_summary
&post[project_id]=XXX&post[group_id]=-1&post[date1]=2016-07-25&post[date2]=2016-08-04&post[searcher]=0&post[region_key]=2