Описание типа PixelSegment

Сегмент, созданный по пикселю.

Формат ответа

Сегмент, созданный по пикселю.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "pixel_id" :  < integer > ,
    "period_length" :  < integer > ,
    "times_quantity" :  < integer > ,
    "times_quantity_operation" :  < pixel_times_quantity_operation > ,
    "utm_source" :  < string > ,
    "utm_content" :  < string > ,
    "utm_campaign" :  < string > ,
    "utm_term" :  < string > ,
    "utm_medium" :  < string > 
}
Параметры Описание
id Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name Название сегмента.
status Статус обработки сегмента.

Возможные значения:

  • uploaded — сегмент с данными пользователя загружен;
  • is_processed — сегмент с заданными параметрами обрабатывается;
  • processed — загрузка и обработка сегмента завершена. Сегмент готов для работы;
  • processing_failed — обработка сегмента завершилась с ошибкой;
  • is_updated — сегмент обновляется;
  • few_data — сегмент содержит мало данных для работы.
create_time Время создания сегмента.
owner Логин владельца сегмента.
pixel_id Идентификатор пикселя.
period_length

Период, за время которого пользователь был замечен пикселем.

Допустимые значения (в сутках): от 1 до 90 (включительно).
times_quantity

Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation

Условие попадания пользователей в сегмент из пикселя.

Возможные значения

  • lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  • eq — равно. Пользователь был замечен пикселем M раз за период.
  • gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
utm_source Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.
Параметры Описание
id Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name Название сегмента.
status Статус обработки сегмента.

Возможные значения:

  • uploaded — сегмент с данными пользователя загружен;
  • is_processed — сегмент с заданными параметрами обрабатывается;
  • processed — загрузка и обработка сегмента завершена. Сегмент готов для работы;
  • processing_failed — обработка сегмента завершилась с ошибкой;
  • is_updated — сегмент обновляется;
  • few_data — сегмент содержит мало данных для работы.
create_time Время создания сегмента.
owner Логин владельца сегмента.
pixel_id Идентификатор пикселя.
period_length

Период, за время которого пользователь был замечен пикселем.

Допустимые значения (в сутках): от 1 до 90 (включительно).
times_quantity

Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation

Условие попадания пользователей в сегмент из пикселя.

Возможные значения

  • lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  • eq — равно. Пользователь был замечен пикселем M раз за период.
  • gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
utm_source Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.