Настройка счетчика

Настройка источников посетителей

url: http://top.mail.ru/json/confsources

Параметр Обязательно Описание
id да ID счетчика
password или session да Пароль или сессия для авторизации
action Тип действия: list/add/remove/edit
name Название источника, для отображения в отчете по человечески.
cond для action=add

Условия достижения добавляемого источника, тип. Строка для условия задается отдельно.

uss - подстрока в URL

rss - подстрока в Referer

rd - переход с сайта (Referer домен с поддоменами)

upv - параметр в URL страницы

substr

для action=add Строка условия источника (помимо substr существуют варианты substr_${cond}, например, substr_uss, substr_rss, ..., но в будущем они могут быть удалены).
string для action=remove|edit Строка источника для удаления или редактирования.
acsrf

Обязательно для action=add/remove/edit. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

Ответ
{
  "acsrf" : STR,
  "action" : STR,
  "elements" : [
    {
      "name" : STR,
      "string" : STR,
      "cond" : STR,
      "substr" : STR
    },
    ...
  ],
  "result" :
  {
     "name" : STR,
     "string" : STR,
     "cond" : STR,
     "substr" : STR
  },
  "error" : INT,
  "errorinfo" : STR,
  "message" : STR,
  ...
}
Описание полей 
Имя
Описание
acsrf acsrf-токен для передачи в запросе для защиты от CSRF
action action в запросе, на который выдан ответ
result

выдает Json объекта, над которым произведена операция: добавленный, удаленный или измененный объект.

Уникальной идентификацией объекта в конфиге является поле string.

error 0 или код ошибки
errorinfo подробное техническое описание ошибки с указанием на его причину возникновнения
message текст ошибки для показа пользователю
elements[].string Идентификация источника.
elements[].name Название источника.
elements[].substr

Условия источника.

elements[].cond

Тип условия:

uss - подстрока в URL

rss - подстрока в Referer

rd - переход с сайта (Referer домена)

upv - параметр в URL страницы

Настройка целей

url: http://top.mail.ru/json/confgoals

Параметр Обязательно Описание
id да ID счетчика
password или session да Пароль или сессия для авторизации
action Тип действия: list/add/remove/edit
name Название цели, для отображения в отчете по человечески.
cond для action=add

Условия достижения добавляемой цели, тип. Строка для условия задается отдельно.

uss - подстрока в URL

rss - подстрока в Referer

hd - глубина просмотра (минимум 2)

ts - время на сайте

jse - событие из JS (используется для указания Названия для события в целях отображения по человечески)

substr

для action=add Строка условия цели (помимо substr существуют варианты substr_${cond}, например, substr_uss, substr_rss, ..., но в будущем они могут быть удалены).
string для action=remove|edit Строка цели для удаления или редактирования.
value Значение цели, суммируемое для данной уникальной цели для каждого достижения. JavaScript цель может указывать разные value при отправке цели.
acsrf

Обязательно для action=add/remove/edit. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

В ответе выдается текущий список целей в объекте elements, и прочие данные.

Ответ
HTTP GET
{
  "acsrf" : STR,
  "action" : STR,
  "filtering" : STR,
  "elements" : [
    {
      "name" : STR,
      "string" : STR,
      "cond" : STR,
      "value" : INT,
      "substr" : STR
    },
    ...
  ],
  "result" :
  {
    "name" : STR,
    "string" : STR,
    "cond" : STR,
    "value" : INT,
    "substr" : STR
  },
  "error" : INT,
  "errorinfo" : STR,
  "message" : STR,
  ...
}
Описание полей 
Имя
Описание
acsrf acsrf-токен для передачи в запросе для защиты от CSRF
action action в запросе, на который выдан ответ
result

выдает Json объекта, над которым произведена операция: добавленный, удаленный или измененный объект.

Уникальной идентификацией объекта в конфиге является поле string

error 0 или код ошибки
errorinfo подробное техническое описание ошибки с указанием на его причину возникновнения
message текст ошибки для показа пользователю
elements[].string Идентификация цели.
elements[].name Название цели.
elements[].value

Значение цели. Может отсутствовать.

elements[].substr

Условие цели.

elements[].cond

Тип условия:

uss - подстрока в URL

rss - подстрока в Referer

ts - время на сайте

hd - глубина просмотра

jse - событие из JS

Настройка списка доменов сайта

url: http://top.mail.ru/json/confmirrors

Параметр Обязательно Описание
id да ID счетчика
password или session да Пароль или сессия для авторизации
action

Тип действия: list/add/remove/edit/on/off

Действия on/off включают и выключают фильтрацию статистики по доменам.

name Название, для отображения в отчете по человечески.
string да Домен. Для проверки точного совпадения без поддоменов перед строкой домена нужно добавить символ ^
acsrf

Обязательно для action=add/remove/edit/on/off. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

Ответ

HTTP GET
{
  "acsrf" : STR,
  "action" : STR,
  "filtering" : STR,
  "elements" : [
    {
      "name" : STR,
      "string" : STR
    },
    ...
  ],
  "result" :
  {
    "name" : STR,
    "string" : STR
  },
  "error" : INT,
  "errorinfo" : STR,
  "message" : STR,
  ...
}
Описание полей 
Имя
Описание
acsrf acsrf-токен для передачи в запросе для защиты от CSRF
filtering

Показывает, включена (on) или выключена (off) функциональность фильтрации хитов по доменам.

Если фильтрация включена, то будет считаться только статистика на указанных доменах.

action action в запросе, на который выдан ответ
result

выдает Json объекта, над которым произведена операция: добавленный, удаленный или измененный объект.

Уникальной идентификацией объекта в конфиге является поле string

error 0 или код ошибки
errorinfo подробное техническое описание ошибки с указанием на его причину возникновнения
message текст ошибки для показа пользователю
elements[].string Домен
elements[].name Название

Настройка фильтра по хостам

url: http://top.mail.ru/json/confhosts

Параметр Обязательно Описание
id да ID счетчика
password или session да Пароль или сессия для авторизации
action

Тип действия: list/add/remove/edit/on/off

Действия on/off включают и выключают фильтрацию статистики по хостам.

name Название, для отображения в отчете по человечески.
string да Хост/сеть. Сеть задается указанием числа действующих битов. Формат: IP или IP/bits
acsrf

Обязательно для action=add/remove/edit/on/off. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

Ответ

HTTP GET
{
  "acsrf" : STR,
  "action" : STR,
  "filtering" : STR,
  "elements" : [
    {
      "name" : STR,
      "string" : STR
    },
    ...
  ],
  "result" :
  {
    "name" : STR,
    "string" : STR
  },
  "error" : INT,
  "errorinfo" : STR,
  "message" : STR,
  ...
}
Описание полей 
Имя
Описание
acsrf acsrf-токен для передачи в запросе для защиты от CSRF
filtering

Показывает, включена (on) или выключена (off) функциональность фильтрации хитов по хостам/сетям.

Если фильтрация включена, то в статистики не попадут данные пользователей из указанных хостов/сетей.

action action в запросе, на который выдан ответ
result

выдает Json объекта, над которым произведена операция: добавленный, удаленный или измененный объект.

Уникальной идентификацией объекта в конфиге является поле string

error 0 или код ошибки
errorinfo подробное техническое описание ошибки с указанием на его причину возникновнения
message текст ошибки для показа пользователю
elements[].string Хост/сеть. Сеть задается указанием числа действующих битов.
elements[].name Название

Тонкие настройки подсчета статистики

url: http://top.mail.ru/json/confprocessing

Параметр Обязательно Описание
id да ID счетчика
password или session да Пароль или сессия для авторизации
action

Тип действия: list/save

substr_{substr}

Отдельная настройка:

substr_UrlParams - сохранение параметров скрипта в URL 

substr_UrlWWW - сохранение www в URL

substr_UrlTrailingSlash - сохранение / в конце URL

substr_UrlHashtag - сохранение хештегов в URL

substr_RefParams - сохранение параметров скрипта в Referrer

substr_RefWWW - сохранение www в Referrer

substr_RefTrailingSlash - сохранение / в конце Referrer

substr_RefHashtag - сохранение хештегов в Referrer

Значение "1" включает отдельную настройку.

При сохранении необходимо прислать ВСЕ отдельные настройки, которые нужно включить, со значением 1. 

Остальные настройки, которые не были присланы, будут выключены.

acsrf

Обязательно для action=save. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

Ответ
HTTP GET
{
  "acsrf" : STR,
  "action" : STR,
  "elements" : [
    {
      "string" : STR,
      "cond" : STR,
      "substr" : STR
    },
    ...
  ],
  "error" : INT,
  "errorinfo" : STR,
  "message" : STR,
  ...
}
Описание полей 
Имя
Описание
acsrf acsrf-токен для передачи в запросе для защиты от CSRF
action action в запросе, на который выдан ответ
error 0 или код ошибки
errorinfo подробное техническое описание ошибки с указанием на его причину возникновнения
message текст ошибки для показа пользователю
elements[].cond Первая часть string до символа ":", обычно keep
elements[].string "keep:{substr}"
elements[].substr

Отдельная настройка:

UrlParams - сохранение параметров скрипта в URL 

UrlWWW - сохранение www в URL

UrlTrailingSlash - сохранение / в конце URL

UrlHashtag - сохранение хештегов в URL

RefParams - сохранение параметров скрипта в Referrer

RefWWW - сохранение www в Referrer

RefTrailingSlash - сохранение / в конце Referrer

RefHashtag - сохранение хештегов в Referrer