Загрузка событий

Методы

Для загрузки событий на сервер MyTracker используйте следующие методы:

• registration и registrationBatch для передачи событий регистрации;
• login и loginBatch для передачи событий авторизации;
• customEvent и customEventBatch для передачи кастомных событий.

Все загруженные данные будут включены в общую статистику и появятся в интерфейсе MyTracker в течение 4 часов

registration

Используйте метод registration для передачи данных о регистрации пользователя.

Формат запроса: https://tracker-s2s.my.com/v1/registration/?idApp=XXX

Обязательный параметр: customUserId.

Для приложений VK Mini Apps обязательными параметрами являются customPlatformUserId и vkPlatform.

registrationBatch

Используйте метод registrationBatch для пакетной передачи данных. Метод аналогичен registration, но позволяет передать сразу несколько событий регистрации.

Формат запроса: https://tracker-s2s.my.com/v1/registrationBatch/?idApp=XXX

Обязательные параметры:

login

Используйте метод login для передачи данных об авторизации пользователя.

Формат запроса: https://tracker-s2s.my.com/v1/login/?idApp=XXX

Обязательный параметр: customUserId.

Для приложений VK Mini Apps обязательными параметрами являются customPlatformUserId и vkPlatform.

loginBatch

Используйте метод loginBatch для пакетной передачи данных. Метод аналогичен login, но позволяет передать сразу несколько событий авторизации.

Формат запроса: https://tracker-s2s.my.com/v1/loginBatch/?idApp=XXX

Обязательные параметры:

customEvent

Используйте метод customEvent для передачи данных о кастомном событии (например, добавление товара в корзину, запись на тест-драйв и пр.).

Формат запроса: https://tracker-s2s.my.com/v1/customEvent/?idApp=XXX

Обязательные параметры: идентификатор пользователя customUserId и/или один из идентификаторов устройства: instanceId, lvid, gaid, appSetId, androidId, idfa, iosVendorId (событие будет привязано к пользователю и/или к устройству).

Для приложений VK Mini Apps обязательными параметрами являются customPlatformUserId и vkPlatform.

Для приложений VK Play обязательными параметрами являются sezamUserId и/или lvid, событие будет привязано к пользователю и/или к устройству.

Специфичные параметры:

* — обязательный параметр.

customEventBatch

Используйте метод customEventBatch для пакетной передачи данных. Метод аналогичен customEvent, но позволяет передать сразу несколько кастомных событий.

Формат запроса: https://tracker-s2s.my.com/v1/customEventBatch/?idApp=XXX

Обязательные параметры:

Параметры

Все параметры передаются в теле POST запроса в формате json.

Ограничение на максимальный размер загружаемых данных — 10Кб.

Примеры запроса

Пример HTTP POST запроса:

curl https://tracker-s2s.my.com/v1/customEvent/?idApp=666 \
–k –X POST --header "Authorization: aaaaaAAAaaa01aaaaaaa1aaAAA11a" \
-d '{"customUserId": "1", "customEventName": "levelUp",
"customEventParams": {"level": "2"}, "idGender": "1",
"age": "25", "eventTimestamp": "1580213208",
"instanceId": "00000000-0000-0000-0000-000000000000"}'

Пример использования PHP SDK:

$idApp = 666;
$token = 'aaaaaAAAaaa01aaaaaaa1aaAAA11a';
$accountCredentials = new Credentials($token);
$customEventMethod = new CustomEventMethod($accountCredentials, $idApp);
$customEventMethod->params()
   ->setCustomUserId('1')
   ->setCustomEventName('levelUp')
   ->addCustomEventParam('level', '2')
   ->setIdGender(Gender::MALE)
   ->setAge(25)
   ->setEventTimestamp(1580213208)
   ->setInstanceId('00000000-0000-0000-0000-000000000000');

$client = Client::getDefault();
$client->request($customEventMethod);

Коды ответов