Create segment

Attention.

Access tokens will not be accepted in URL parameters starting February 13, 2019. To continue working with the Yandex.Metrica API, set up authorization by passing the token in the HTTP header.

The outdated authorization method will be temporarily disabled on January 23, January 30, and February 6 for maintenance. Authorization using URL parameters will be unavailable on these dates.

Creates segment with set parameters. A segment created via the API is not displayed in the Yandex.Metrica web interface. The API is allowed to create up to 500 segments for one counter, just like the web interface. Thus, the total possible number of segments is 1 000.

  1. Request syntax
  2. Request message body
  3. Response format

Request syntax

counterId — counter id.

https://api-metrica.yandex.net/management/v1/counter/{counterId}/apisegment/segments
 ? 

Request message body


{
    "segment" : {
        "name" :  < string > ,
        "expression" :  < string > ,
        "segment_source" :  < segment_source > 
    }
}
ParametersDescription
segmentSegment.
segment
nameSegment name.
expressionВыражение, которое соответствует значению параметра filters.
segment_sourceSegment source. Indicates the means of its creation. Accepts the value api — uses segments created through the API.

Request example

POST https://api-metrica.yandex.net/management/v1/counter/{counterId}/apisegment/segments?

Response format


{
    "segment" : {
        "segment_id" :  < integer > ,
        "counter_id" :  < integer > ,
        "name" :  < string > ,
        "expression" :  < string > ,
        "segment_source" :  < segment_source > 
    }
}
ParametersDescription
segmentSegment.
segment
segment_idSegment ID.
counter_idCounter ID.
nameSegment name.
expressionВыражение, которое соответствует значению параметра filters.
segment_sourceSegment source. Indicates the means of its creation. Accepts the value api — uses segments created through the API.