Change segment

Changes the specified segment. A segment changed via the API is not displayed in the Yandex.Metrica web interface.

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

Request syntax

counterId — counter id.

segmentId — ID of segment you want to update.

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

Request message body


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

Request example

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

Response format


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