Создание сегмента с типом "pixel"

Создает сегмент типа pixel с заданными параметрами. Если при создании сегмента используются различные условия (например, заданы несколько меток), то в сегмент попадет пользователь, который удовлетворяет одновременно всем заданным условиям.

Request

POST

https://api-audience.yandex.ru/v1/management/segments/create_pixel

Body

application/json

{
  "segment": {
    "name": "example",
    "pixel_id": 0,
    "period_length": 1,
    "times_quantity_operation": "example",
    "times_quantity": 0,
    "utm_source": "example",
    "utm_content": "example",
    "utm_campaign": "example",
    "utm_term": "example",
    "utm_medium": "example",
    "device_matching_type": "example"
  }
}

Name

Description

segment

Type: SegmentRequestPixel

Сегмент с заданными параметрами.

Example

{
  "name": "example",
  "pixel_id": 0,
  "period_length": 1,
  "times_quantity_operation": "example",
  "times_quantity": 0,
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example",
  "device_matching_type": "example"
}

SegmentRequestPixel

Сегмент с заданными параметрами.

Name	Description
name	Type: string Название сегмента. Example: `example`
pixel_id	Type: integer Идентификатор пикселя.
period_length	Type: integer Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно). Min value: `1` Max value: `90`
times_quantity	Type: integer Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Type: string Условие попадания пользователей в сегмент из пикселя. Допустимые значения: `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. `eq` — равно. Пользователь был замечен пикселем M раз за период. `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период. Example: `example`
utm_campaign	Type: string Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_content	Type: string Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_medium	Type: string Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_source	Type: string Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_term	Type: string Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`

Example

{
  "name": "example",
  "pixel_id": 0,
  "period_length": 1,
  "times_quantity_operation": "example",
  "times_quantity": 0,
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}

Responses

200 OK

Body

application/json

{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0,
    "pixel_id": 0,
    "period_length": 0,
    "times_quantity": 0,
    "times_quantity_operation": "example",
    "utm_source": "example",
    "utm_content": "example",
    "utm_campaign": "example",
    "utm_term": "example",
    "utm_medium": "example",
    "pattern": "example"
  }
}

Name

Description

segment

Type: PixelSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example",
  "pattern": "example"
}

BaseSegment

Тип для описания сегмента.

Name	Description
name	Type: string Название сегмента. Example: `example`
create_time	Type: string<date-time> Время создания сегмента. Example: `2025-01-01T00:00:00Z`
id	Type: integer Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
owner	Type: string Логин владельца сегмента. Example: `example`
status	Type: string Статус обработки сегмента. Допустимые значения: `uploaded` — сегмент с данными пользователя загружен. `is_processed` — сегмент с заданными параметрами обрабатывается. `processed` — загрузка и обработка сегмента завершена. Сегмент готов для работы. `processing_failed` — обработка сегмента завершилась с ошибкой. `is_updated` — сегмент обновляется. `few_data` — сегмент содержит мало данных для работы. Example: `example`
type	Type: string Тип сегмента. Допустимые значения: `uploading` — сегмент, созданный из файла с пользовательскими данными. `metrika` — сегмент, импортируемый из Яндекс Метрики. `appmetrica` — сегмент, импортируемый из AppMetrica. `lookalike` — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike). `geo` — сегмент на основе данных о геолокации по полигонам и по окружностям. `pixel` — сегмент, созданный по пикселю. Example: `example`

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

PixelSegment

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

All of 2 types

Type: BaseSegment

Тип для описания сегмента.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

period_length	Type: integer Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
pixel_id	Type: integer Идентификатор пикселя.
times_quantity	Type: integer Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Type: string Условие попадания пользователей в сегмент из пикселя. Допустимые значения: `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. `eq` — равно. Пользователь был замечен пикселем M раз за период. `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период. Example: `example`
utm_campaign	Type: string Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_content	Type: string Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_medium	Type: string Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_source	Type: string Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_term	Type: string Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`

Example

{
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}

Была ли статья полезна?

Создание сегмента из CSV-файла

Создание сегмента из объекта метрики