Changing a segment

Changes the specified segment. The segment updated via the API isn't displayed in the Yandex Metrica web interface.

Request syntax

counterId: Tag ID.

segmentId: ID of the segment that you want to update.

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

In the request body


{
    "segment" : {
        "name" :  < string > ,
        "expression" :  < string > ,
        "segment_source" :  < segment_source > 
    }
}
Parameters Description
segment Segment.
segment
name Segment name.
expression An expression that matches the value of the "filters" parameter.
segment_source Segment source. Indicates its creation method. Accepts the value api — uses segments created through the API.
Parameters Description
segment Segment.
segment
name Segment name.
expression An expression that matches the value of the "filters" parameter.
segment_source Segment source. Indicates its creation method. Accepts the value api — uses segments created through the API.

Sample request

PUT https://api-metrika.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 Tag ID.
name Segment name.
expression An expression that matches the value of the "filters" parameter.
segment_source Segment source. Indicates its creation method. Accepts the value api — uses segments created through the API.
Parameters Description
segment Segment.
segment
segment_id Segment ID.
counter_id Tag ID.
name Segment name.
expression An expression that matches the value of the "filters" parameter.
segment_source Segment source. Indicates its creation method. Accepts the value api — uses segments created through the API.