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

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

Request

POST

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

Body

application/json
{
  "segment": {
    "name": "example",
    "metrika_segment_type": "example",
    "metrika_segment_id": 0
  }
}

Name

Description

segment

Type: SegmentRequestMetrika

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

Example
{
  "name": "example",
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}

SegmentRequestMetrika

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

Name

Description

metrika_segment_type

Type: string

Вид объекта в Метрике. Допустимые значения:

  • counter_id — счетчик.
  • goal_id — цель.
  • segment_id — сегмент.

Example: example

name

Type: string

Название сегмента.

Example: example

metrika_segment_id

Type: integer

Идентификатор объекта из Метрики.
Example
{
  "name": "example",
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}

Responses

200 OK

OK

Body

application/json
{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "metrika_segment_type": "example",
    "metrika_segment_id": 0
  }
}

Name

Description

segment

Type: MetrikaSegment

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

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

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"
}

MetrikaSegment

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

All of 2 types

  • Type: BaseSegment

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

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

    metrika_segment_id

    Type: integer

    Идентификатор объекта из Метрики.

    metrika_segment_type

    Type: string

    Вид объекта в Метрике. Допустимые значения:

    • counter_id — счетчик.
    • goal_id — цель.
    • segment_id — сегмент.

    Example: example
    Example
    {
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}
Предыдущая
Создание сегмента с типом "pixel"
Следующая
Создание сегмента с типом "lookalike"