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

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

Request

POST

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

Body

application/json

{
    "segment": {
        "name": "string",
        "metrika_segment_type": "string",
        "metrika_segment_id": 0
    }
}

Name

Description

segment*

Type: SegmentRequestMetrika

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

SegmentRequestMetrika

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

Name	Description
metrika_segment_type*	Type: string Вид объекта в Метрике. Допустимые значения: `counter_id` — счетчик. `goal_id` — цель. `segment_id` — сегмент.
name*	Type: string Название сегмента.
metrika_segment_id	Type: integer<int64> Идентификатор объекта из Метрики.

Responses

200 OK

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "metrika_segment_type": "string",
        "metrika_segment_id": 0
    }
}

Name

Description

segment

Type: MetrikaSegment

Сегмент, импортируемый из Яндекс Метрики.
Тип для описания сегмента.

MetrikaSegment

Сегмент, импортируемый из Яндекс Метрики.

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

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

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

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