Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

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

  • event - название события

  • strimix_avid - идентификатор анонимного посетителя сайта

  • user_external_id - идентификатор пользователя

Info

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

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

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

...

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

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

Code Block
languagejs
strimix.push({"event":"page_view"})

...

В случае повторной отправки события с идентификатором сделки по которому ранее была создана сделка - произойдет обновление всех атрибутов существующей в 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

Нет

Кастомные параметры атрибуты сделки.

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

Имя

Тип

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

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

Описание

custom_param_key_1

string

Нет

string_value

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

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

custom_param_key_2

number

Нет

123.0

custom_param_key_3

boolean

Нет

true

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

Code Block
languagejs
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 server-side API:

Code Block
languagejson
{
  "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
    }
  }
}

...

В случае повторной отправки события с идентификатором заказа по которому ранее был создан заказ - произойдет обновление всех атрибутов существующего в 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

Нет

Кастомные параметры атрибуты заказа.

Anchor
order_custom_params
order_custom_params
Кастомные параметры атрибуты заказа:

Имя

Тип

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

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

Описание

custom_param_key_1

string

Нет

string_value

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

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

custom_param_key_2

number

Нет

123.0

custom_param_key_3

boolean

Нет

true

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

Code Block
languagejs
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 server-side API:

Code Block
languagejson
{
  "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:

Code Block
languagejs
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 server-side API:

Code Block
languagejson
{
  "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"
}

...