События и их атрибуты

Событие - это единица измерения взаимодействия пользователя с сайтом или продвижением клиента по воронке продаж.

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

Атрибуты события - это данные, которые предоставляют дополнительную информацию о событии. Атрибуты события могут быть числовыми, текстовыми или логическими (булево значение).

Обязательными атрибутами событий Strimix являются:

event - название события
strimix_avid - идентификатор анонимного посетителя сайта
user_external_id - идентификатор пользователя

strimix_avid и user_external_id можно передавать как вместе, так и только один из них. Но в любом случае в событии должен присутствовать как минимум один из этих атрибутов! Иначе событие не будет обработано в Strimix.

Необязательный атрибут события:

timestamp - время регистрации события в UNIX формате (в миллисекундах).

По умолчанию Strimix устанавливает timestamp события равным значению UNIX timestamp на момент регистрации события в системе.

Однако этот атрибут можно перезаписать, например если события отправляются в режиме отложенной пакетной загрузки, а в не в режиме стриминга в реальном времени. Это позволит передать в Strimix фактическое время совершения события.

Спецификация системных событий Strimix

page_view

Это событие автоматически отправляет код отслеживания Strimix во время просмотра страницы сайта.

Пример отправки события с помощью кода отслеживания Strimix:

strimix.push({"event":"page_view"})

deal

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

В случае повторной отправки события с идентификатором сделки по которому ранее была создана сделка - произойдет обновление всех атрибутов существующей в Strimix сделки.

Параметры события:

Имя	Тип	Обязательно?	Пример значения	Описание
id	string	Да	655fd150deea972254b7b1d4	Идентификатор сделки CRM.
status	string	Нет	new	Статус сделки CRM.
manager	string	Нет	Dima	Менеджер закрепленный за сделкой CRM.
promo_action	string	Нет	black_friday	Название промоакции или значение промо-кода примененного в сделке CRM.
payment_method	string	Нет	stripe	Способ оплаты в сделке.
value	number		100.0	Сумма сделки.
paid_value	number		100.0	Оплаченная сумма сделки.
refund_value	number		100.0	Сумма возвращенных платежей по сделке.
currency	string		USD	Валюта сделки в 3-буквенном формате ISO 4217. Если указанная в событии валюта отличается от валюты проекта - значения атрибутов value, paid_value, refund_value будут конвертированы по курсу Open Exchange Rate на дату импорта.
custom_params	object	Нет		Кастомные параметры сделки.

Кастомные параметры сделки:

Имя

Тип

Обязательно?

Пример значения

Описание

custom_param_key_1

string

Нет

string_value

Значение кастомного параметра сделки.

Может быть строкой, номером или булевым значением.

custom_param_key_2

number

Нет

123.0

custom_param_key_3

boolean

Нет

true

Пример отправки события deal с помощью кода отслеживания Strimix:

strimix.push({
  "event":"deal",
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  },
  "deal": {
    "id": "655fd150deea972254b7b1d4",
    "status": "paid",
    "manager": "Dmitry Yatsenko",
    "value": 100.0,
    "paid_value": 50.0,
    "currency": "USD",
    "payment_method": "stripe",
    "promo_action": "Black Friday",
    "custom_params": {
      "offer_name": "50% discount",
      "products_cost_price": 20.0,
      "is_new_cutomer": true
    }
  }
})

Пример JSON-строки для отправки события deal через Strimix API:

{
  "timestamp": 1705360211599,
  "event":"deal",
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  },
  "strimix_avid": "7178bd4a-18f9-4e5d-8b72-228dad815bdc",
  "deal": {
    "id": "655fd150deea972254b7b1d4",
    "status": "paid",
    "manager": "Dmitry Yatsenko",
    "value": 100.0,
    "paid_value": 50.0,
    "currency": "USD",
    "payment_method": "stripe",
    "promo_action": "Black Friday",
    "custom_params": {
      "offer_name": "50% discount",
      "products_cost_price": 20.0,
      "is_new_cutomer": true
    }
  }
}

order

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

В случае повторной отправки события с идентификатором заказа по которому ранее был создан заказ - произойдет обновление всех атрибутов существующего в Strimix заказа.

Параметры события:

Имя	Тип	Обязательно?	Пример значения	Описание
id	string	Да	655fd150deea972254b7b1d4	Идентификатор заказа.
status	string	Нет	new	Статус заказа.
manager	string	Нет	Dima	Менеджер обрабатывающий заказ.
promo_action	string	Нет	SALE777	Название промоакции или значение промо-кода примененного в заказе.
payment_method	string	Нет	stripe	Способ оплаты заказа.
value	number		100	Сумма заказа.
paid_value	number		100	Оплаченная сумма заказа.
refund_value	number		100	Сумма возвращенных платежей по заказу.
currency	string		USD	Валюта заказа в 3-буквенном формате ISO 4217. Если указанная в событии валюта отличается от валюты проекта - значения атрибутов value, paid_value, refund_value будут конвертированы по курсу Open Exchange Rate на дату импорта.
custom_params	object	Нет		Кастомные параметры заказа.

Кастомные параметры заказа:

Имя

Тип

Обязательно?

Пример значения

Описание

custom_param_key_1

string

Нет

string_value

Значение кастомного параметра заказа.

Может быть строкой, номером или булевым значением.

custom_param_key_2

number

Нет

123.0

custom_param_key_3

boolean

Нет

true

Пример отправки события order с помощью кода отслеживания Strimix:

strimix.push({
  "event":"order",
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  },
  "order": {
    "id": "655fd150deea972254b7b1d4",
    "status": "paid",
    "manager": "Dmitry Yatsenko",
    "value": 100.0,
    "paid_value": 50.0,
    "currency": "USD",
    "payment_method": "stripe",
    "promo_action": "Black Friday",
    "custom_params": {
      "offer_name": "50% discount",
      "products_cost_price": 20.0,
      "is_new_cutomer": true
    }
  }
})

Пример JSON-строки для отправки события order через Strimix API:

{
  "timestamp": 1705360211599,
  "event":"order",
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  },
  "strimix_avid": "7178bd4a-18f9-4e5d-8b72-228dad815bdc",
  "order": {
    "id": "655fd150deea972254b7b1d4",
    "status": "paid",
    "manager": "Dmitry Yatsenko",
    "value": 100.0,
    "paid_value": 50.0,
    "currency": "USD",
    "payment_method": "stripe",
    "promo_action": "Black Friday",
    "custom_params": {
      "offer_name": "50% discount",
      "products_cost_price": 20.0,
      "is_new_cutomer": true
    }
  }
}

Отправка кастомных событий

Во время отправки кастомных событий можно передавать кастомные параметры события. Кастомные параметры необходимо указать в атрибуте event_params. Кастомный параметр может иметь следующие типы значений: строка, число, булево значение:

Имя

Тип

Обязательно?

Пример значения

Описание

custom_param_key_1

string

Нет

string_value

Значение кастомного параметра события.

Может быть строкой, номером или булевым значением.

custom_param_key_2

number

Нет

123.0

custom_param_key_3

boolean

Нет

true

Пример отправки кастомного события с помощью кода отслеживания Strimix:

strimix.push({
  "event":"custom_event_name",
  "event_params": {
    "custom_param_key_1": "string_value",
    "custom_param_key_2": 123.0,
    "custom_param_key_3": true
  },
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  }
})

Пример JSON-строки для отправки кастомного события через Strimix API:

{
  "timestamp": 1705360211599,
  "event":"custom_event_name",
  "event_params": {
    "custom_param_key_1": "string_value",
    "custom_param_key_2": 123.0,
    "custom_param_key_3": true
  },
  "user_external_ids": {
    "crm_client_id": "655fd150deea972254b7b1d4"
  },
  "strimix_avid": "7178bd4a-18f9-4e5d-8b72-228dad815bdc"
}