Upload customer data (CSV)

Uploads customer data.

The data is transmitted as multipart/form-data in CSV format. In the first line of the request, pass the names of the columns. Learn more about the format of transmitted data.

Note

File size limit: 1 GB.

Example of an uploaded file.

Sample request

POST https://api-metrica.yandex.net/cdp/api/v1/counter/2215573/data/contacts/csv?
    merge_mode=SAVE&
    columns_mapping=
        "uniq_id":"ID",
        "name":"Name",
        "emails":"Email",
        "age":"Age"&
    delimiter_type=COMMA
Content-Type: multipart/form-data; boundary=------------------------7zDUQOAIAE9hEWoV
Context-Length: TBD

--------------------------7zDUQOAIAE9hEWoV
Content-Disposition: form-data; name="file"; filename="data.csv"
Content-Type: text/csv

ID,Name,Email,Age
11,John J.,example@example.com,40
42,Michael L.,somebody@example.com,24
--------------------------7zDUQOAIAE9hEWoV--

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts/csv

Path parameters

Name

Description

counterId

Type: integer

ID of the counter that you want to upload customer data for.

Query parameters

Name	Description
columns_mapping	Type: string Correspondence between column names and attribute names. Pattern: `"([^"]+)":"([^"]+)"` Example: `"uniq_id":"ID","name":"Name","birth_date":"Date of birth"`
merge_mode	Type: string Data saving mode. For any value, pass all required fields, even ones that aren't modified. `SAVE`: All previously transmitted data is completely replaced with new data. Details. `UPDATE`: Only the data that you're currently uploading is updated. Details. `APPEND`: New data is added to previously uploaded data. Details. Example: `SAVE`
delimiter_type	Type: string Type of column separator used in the file: `COMMA`: Comma separator. `SEMICOLON`: Semicolon separator. Default: `COMMA` Example: ``

Body

multipart/form-data

{
  "file": "example"
}

Name

Description

file

Type: string<binary>

File size limit: 1 GB.

Example: example

Responses

200 OK

Body

application/json

{
  "uploading": {
    "uploading_id": "example",
    "datetime": "2025-01-01T00:00:00Z",
    "api_validation_status": "example",
    "elements_count": 0,
    "entity_type": "example",
    "entity_subtype": "example",
    "uploading_format": "example",
    "uploading_source": "example",
    "api_validation_errors": [
      "example"
    ],
    "uploading_title": "example"
  }
}

Name

Description

uploading

Type: UploadingMetaExternal

Upload information

Example

{
  "uploading_id": "example",
  "datetime": "2025-01-01T00:00:00Z",
  "api_validation_status": "example",
  "elements_count": 0,
  "entity_type": "example",
  "entity_subtype": "example",
  "uploading_format": "example",
  "uploading_source": "example",
  "api_validation_errors": [
    "example"
  ],
  "uploading_title": "example"
}

UploadingMetaExternal

Upload information

Name	Description
api_validation_status	Type: string Upload validation status: `PASSED`: Validation passed. `FAILED`: Validation failed. Example: `example`
datetime	Type: string<date-time> Upload time. Example: `2025-01-01T00:00:00Z`
elements_count	Type: integer Number of elements within the upload.
entity_type	Type: string Entity type: `SYSTEM`: System entity, such as contacts or orders. `CUSTOM_LIST`: Custom list. `SYSTEM_LIST`: System list, such as products. Example: `example`
uploading_format	Type: string Upload format. Possible values: `JSON` `CSV` Example: `example`
uploading_id	Type: string Upload ID. Example: `example`
uploading_source	Type: string Upload source. Possible values: `API` Example: `example`

Example

{
  "uploading_id": "example",
  "datetime": "2025-01-01T00:00:00Z",
  "api_validation_status": "example",
  "elements_count": 0,
  "entity_type": "example",
  "uploading_format": "example",
  "uploading_source": "example"
}

Was the article helpful?

Customer data format

Uploading customer data (JSON)