Saving a segment created from a file

Saves a segment created from a file with data.

Request

POST

https://api-audience.yandex.ru/v1/management/segment/{segmentId}/confirm

Path parameters

Name

Description

segmentId*

Type: integer<int32>

ID of the segment that you want to save.

Query parameters

Name

Description

check_size

Type: boolean

You can create segments with less than 100 records using this parameter. However, you can't use these segments for promotion in Yandex Direct until their size exceeds 100 records.

Default: true

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "hashed": false,
        "hashing_alg": "string",
        "content_type": "string"
    }
}

Name

Description

segment*

Type: SegmentRequestUploading

The segment with the specified parameters.

SegmentRequestUploading

The segment with the specified parameters.

Name	Description
content_type*	Type: string Type of file content. Acceptable values: `idfa_gaid`: Device IDs. `mac`: MAC addresses. `crm`: CRM data.
name*	Type: string Segment name
hashed	Type: boolean Whether every string in the uploaded file is hashed. Acceptable values: `true`: Hashed. `false`: Unhashed.
hashing_alg	Type: string The hashing algorithm used for the data is sent for `hashed: true`. Acceptable values: `MD5`. `SHA256`. Note Starting in January 2025, uploading new MD5 hashes will no longer be supported. Please use SHA256 to upload data.
id	Type: integer<int32> ID of the segment. Specify this parameter when updating a segment.

Responses

200 OK

Body

application/json

{
    "segment": {
        "type": "string",
        "id": 0,
        "name": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "hashed": false,
        "used_hashing_alg": "string",
        "content_type": "string",
        "device_matching_type": "string"
    }
}

Name

Description

segment

Type: UploadingSegment

A segment created from a file with user data.
The segment description by type.

UploadingSegment

A segment created from a file with user data.

Name	Description
name*	Type: string Segment name.
used_hashing_alg*	Type: string The hashing algorithm used for the data is sent for `hashed: true`. Acceptable value: `SHA256`. Starting January 2025, uploading new MD5 hashes is no longer supported. To upload new data, use SHA‑256.
content_type	Type: string Type of file content. Acceptable values: `idfa_gaid`: Device IDs. `mac`: MAC addresses. `crm`: CRM data.
create_time	Type: string<date-time> The time of segment creation.
device_matching_type	Type: string Device search mode for the segment. Acceptable values: `CROSS_DEVICE`: The segment includes other devices associated with the uploaded ID and belonging to the same user. This is the default value if no search mode is selected. `IN_DEVICE`: The segment includes only the uploaded devices, without expanding to other devices. Currently, the `IN_DEVICE` mode is available only for `idfa_gaid` segments.
hashed	Type: boolean Whether every string in the uploaded file is hashed. Acceptable values: `true`: Hashed. `false`: Unhashed.
id	Type: integer<int32> ID of the segment. Specify this parameter when updating a segment.
owner	Type: string The username of the segment owner.
status	Type: string Status of processing the segment. Acceptable values: `uploaded`: The segment with the user's data has been uploaded. `is_processed`: The segment with the specified parameters is being processed. `processed`: The segment has been uploaded and processed. The segment is ready to use. `processing_failed`: Segment processing has failed. `is_updated`: The segment is updating. `few_data`: The segment has insufficient data.
type	Type: string Segment type. Acceptable values: `uploading`: A segment created from a file with user data. `metrika`: A segment imported from Yandex Metrica. `appmetrica`: A segment imported from AppMetrica. `lookalike`: A segment of users who "look like" one of the client's other segments (uses the "lookalike" technology). `geo`: A segment based on location data for polygons and circles. `pixel`: A segment created using a tracking pixel.

Was the article helpful?

Modifying the data for a segment created from a file

Saving a Yandex Metrica ClientId segment generated from a file