Import events

Methods

To send events and their parameters, use the following methods:

• registration and registrationBatch for registration events;
• login and loginBatch for authorization events;
• customEvent and customEventBatch for custom events.

Uploaded events will be added to the project data and will appear in MyTracker reports within 4 hours

registration

Use the registration method to send data on the registration.

Request format: https://tracker-s2s.my.com/v1/registration/?idApp=XXX

Required parameters: customUserId.

Required parameters for VK Mini Apps: customPlatformUserId and vkPlatform.

registrationBatch

Use the registrationBatch method to send batch data on registrations. This method is similar to registration but allows you to send more than one event.

Request format: https://tracker-s2s.my.com/v1/registrationBatch/?idApp=XXX

Required parameters:

login

Use the login method to send data on the authorization.

Request format: https://tracker-s2s.my.com/v1/login/?idApp=XXX

Required parameters: customUserId.

Required parameters for VK Mini Apps: customPlatformUserId and vkPlatform.

loginBatch

Use the loginBatch method to send batch data on authorizations. This method is similar to login but allows you to send more than one event.

Request format: https://tracker-s2s.my.com/v1/loginBatch/?idApp=XXX

Required parameters:

customEvent

Use the customEvent method to send data on the custom event (for example, adding to cart, registering for a test drive, and so on).

Request format: https://tracker-s2s.my.com/v1/customEvent/?idApp=XXX

Required parameters: a user identifier customUserId and/or one of the device identifiers: instanceId, lvid, gaid, androidId, appSetId, idfa, iosVendorId (the event will be related to the user and/or the device).

Required parameters for VK Mini Apps: customPlatformUserId and vkPlatform.

Required parameters for VK Play: sezamUserId and/or lvid. The event will be related to the user and/or the device.

Specific parameters:

* — required parameter.

customEventBatch

Use the customEventBatch method to send batch data on custom events. This method is similar to customEvent but allows you to send more than one event.

Request format: https://tracker-s2s.my.com/v1/customEventBatch/?idApp=XXX

Required parameters:

Parameters

All parameters are passed in the request body in JSON format.

Limit on the maximum size of imported data — 10Kb.

Example query

HTTP POST request:

curl https://tracker-s2s.my.com/v1/customEvent/?idApp=666 \
–k –X POST --header "Authorization: skjdfASFasf03asdffar3asJHB32r" \
-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 = 'skjdfASFasf03asdffar3asJHB32r';
$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);

Status codes