Основные параметры

Путь к JSON API

Практически каждый отчет top.mail.ru имеет урл для получения ответа в  json виде.

Для этого к пути отчета необходимо добавить префикс /json: например, чтобы получить данные отчета "Динамика визитов" с урлом https://top.mail.ru/visits?id=36383&days=30 в форме json нужно запрашивать https://top.mail.ru/json/visits?id=36383&days=30

Практически все параметры используемые в веб отчетах так же доступны в запросах к json.

Идентификация, аутентификация и авторизация

ПараметрТипОписание
idчисло
Идентификатор счетчика. Каждый сайт идентифицируется по id счетчика, который выдается при регистрации.
password
пароль
Пароль к счетчику для аутентификации и/или авторизации. В API при аутентификации по хешу от пароля password не требуется, вместо него используется параметр ph. В API после аутентификации в /json/login для авторизации можно применять session.
session
идентификатор
Сессия для авторизации.


Выбор даты и периода статистики


Параметр

Тип

Описание

period 0|1|2 Периодичность статистики: день (0, по умолчанию), календарная неделя (1) и календарный месяц (2).
date YYYY-MM-DD Дата в формате YYYY-MM-DD, на который запрашивается статистика. Для периодов неделя и месяц можно указать любую дату желаемой недели и месяца, соответственно. По умолчанию, текущая дата.
ago число Альтернативный способ задания желаемой даты. Указывается число дней назад от текущей даты. Например, ago=0 означает текущую дату, ago=1 – вчера.
date2 YYYY-MM-DD Дата для выбора данных сравнения, условия как для date.
ago2 число Аналогично ago, для выбора данных сравнения.
aggregation sum|avg Выбор агрегации: суммарные (sum) данные за период или среднесуточные (avg) данные за период (неделю/месяц)



Выбор демографического среза

Для большинства отчетов можно указывать пол и/или возраст посетителя, и в отчете статистика будет построена только по данным выбранной соцдем группы.

Параметр
Тип
Описание
gender 0|1|2 Выбор пола: все (0), только мужчины (1), только женщины (2)
agegroup 0|1|2|3|4|5|6|7|8|9

Выбор возрастной группы:

  • все (0),
  • до 12 (1)
  • 12-18 (2)
  • 19-24 (3)
  • 25-30 (4)
  • 31-35 (5)
  • 36-40 (6)
  • 41-45 (7)
  • 46-50 (8)
  • старше 50 (9)


Прочие параметры

Параметр
Тип
Описание
callback идентификатор Параметр для передачи имени функции обратного вызова в JSONP запросах.
sids строка Выбор элементов в запросах динамики изменения показателей. sid элементов указывается через запятую.
dynamics число Указывает число периодов для запроса динамики.
list yes|no Выбор списочного вывода для отчетов представляемых в древовидной форме (География, Операционные системы, Браузеры, Мобильные устройства)
advertiser all|merge|... Выбор рекламной системы в запросах статистики перехода с рекламных систем. Все возможные варианты рекламных систем выдаются в массиве adverts в ответе. При выборе рекламной системы статистика будет выдана только по выбранной системе. Служебные all и merge позволяют получить все переходы, по отдельности и в объединенном виде, соответственно.
rettype  

В отчете Точки входа с соцсетей и Точки входа из поисковиков

Выбор соцсети (поисковика) в запросах статистики. Все возможные варианты соцсетей (поисковиков) выдаются в массиве soclist (srchlist) в ответе. При выборе соцсети (поисковика) статистика будет выдана только по выбранной соцсети (поисковику). Служебные all и merge позволяют получить все входы, по отдельности и в объединенном виде, соответственно.

В отчете Источники

Выбор источника с учетом древовидной структуры. Выдаются источники входящие в выбранный узел дерева. Для получения корневых элементов нужно передать один символ "/".


goal   Выбор цели по которому показывается дополнительная информация.
showtype visitors/hits/ratio Выбор показателя (посетители/просмотры/глубина просмотров) в отчете Демография.
source строка

Выбор источника по которому показывается дополнительная информация. 


Динамика визитов

Параметр
Тип
Описание
full yes Полнота выдаваемых данных. Обычно в выводе отсутствуют периоды без посещений.
back число Глубина выдачи в динамике визитов в днях.


Поминутная динамика

Для выбора даты данных сравнения используются параметры date2 или ago2.

Параметр
 Тип
Описание
smooth   Включение сглаживания данных
order   Порядок данных: по возрастанию минут (asc) или по убыванию.
what hits|visitors|newvisitors|hpv тип данных: просмотры (hits), уникальные посетители (visitors), новые (с начала суток) посетители (newvisitors), просмотров на посетителя (hpv)
embed_width число В запросах /mdynamics.embed ширина встраиваемого графика в пикселях
embed_width_p процент (0-100) В запросах /mdynamics.embed ширина встраиваемого графика в процентах от ширины viewport
embed_height число В запросах /mdynamics.embed высота встраиваемого графика в пикселях
embed_height_p процент (0-100) В запросах /mdynamics.embed высота встраиваемого графика в процентах от высоты viewport


Постраничный вывод данных

Параметр
 
Описание
pp число (10|20|50|100|200|500) Число элементов на странице. Для владельцев сайта запрашиваемой статистики доступны также число элементов 1000, 2000 и 5000.
sf число Номер элемента для выбора страницы, отсчет от 0. Например, если sf=0, то это первая страница, а при sf=35 и pp=10 это будет четвертая страница.


Фильтр по подстроке

Параметр
 Тип
Описание
filter_type 0|1|2

Фильтр:

  • только строк содержащих заданные подстроки (0)
  • строк кроме содержащих заданные подстроки (1)
  • вывод всех строк без фильтра (2)
filter строка

Подстроки для фильтра. Разделителем подстрок является пробел (в отчетах с урлами и доменами) или точка с запятой (в поисковых запросах, пользовательских событиях, json/customevents) в зависимости от отчета.


Поисковые запросы

Параметр
Тип 
Описание
searcher all|merge|... Выбор поисковика в запросах статистики перехода с поисковых систем. Все возможные варианты поисковых систем выдаются в массиве srchlist в ответе. При выборе поисковой системы статистика будет выдана только по выбранной системе. Служебные all и merge позволяют получить все переходы, по отдельности и в объединенном виде, соответственно.
kwsearch    Получение рейтинга сайтов по конкретному поисковому запросу.


Разрешение экрана и viewport

Параметр
Тип 
Описание
disc   Округление ширины и высоты разрешения экрана или viewport.
dir  width|height  Группировка и вывод статистики только ширине или высоте.


Переходы

Параметр
Тип 
Описание
url   Выбор урла страницы по которому выдается информация о переходах. 
showall  0|1 Показ всех переходов по урлу.
maxLinksчислоМаксимальное число выдаваемых переходов по урлу. По умолчанию 12.


Retention

Параметр
Тип 
Описание
dynamics    Длина истории retention по дням.
period2  число  Период retention, возможные значения: 1 - день, 2 - 7 дней , 3 - 14 дней ,4 - 21 день, 5 - 30 дней, 6 - неделя, 7 - месяц
limit   Глубина дней, недель, …  в ответе (зависит от preriod2) начиная от date. Например, если мы хотим получить все дни начиная от date, то limit=91&period2=1. Параметр не обязательный.