Creating a segment with the “lookalike” type

Creates a “lookalike” segment with the specified parameters.

Request syntax

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

In the request body


{
    "segment" : {
        "name" :  < string > ,
        "lookalike_link" :  < integer > ,
        "lookalike_value" :  < integer > ,
        "maintain_device_distribution" :  < boolean > ,
        "maintain_geo_distribution" :  < boolean > 
    }
}


Parameters	Description
segment	The segment with the specified parameters.
segment
name	Segment name.
lookalike_link	ID of the segment that the created segment should be similar to.
lookalike_value	The degree of “similarity”. Accepts the values 1 2 3 4 5.
maintain_device_distribution	Distribute users by device type. Acceptable values: true — The distribution of users by device type is maintained, if possible. false – The distribution of users by device type is ignored. Default value: true.
maintain_geo_distribution	Distribute users by city. Acceptable values: true — The distribution of users by city is maintained, if possible. false – The distribution of users by city is ignored. Default value: true.


Parameters	Description
segment	The segment with the specified parameters.
segment
name	Segment name.
lookalike_link	ID of the segment that the created segment should be similar to.
lookalike_value	The degree of “similarity”. Accepts the values 1 2 3 4 5.
maintain_device_distribution	Distribute users by device type. Acceptable values: true — The distribution of users by device type is maintained, if possible. false – The distribution of users by device type is ignored. Default value: true.
maintain_geo_distribution	Distribute users by city. Acceptable values: true — The distribution of users by city is maintained, if possible. false – The distribution of users by city is ignored. Default value: true.

Sample request

POST https://api-audience.yandex.ru/v1/management/segments/create_lookalike?

Response format


{
    "segment" :  < _lookalike_segment > 
}


Parameters	Description
segment	The segment with the specified parameters.