Загрузка данных о клиентах (JSON)

Выполняет загрузку данных о клиентах.

Данные передаются как JSON в теле POST-запроса.

Синтаксис запроса

counterId — идентификатор счетчика, для которого вы хотите загрузить контакты.

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts
 ? merge_mode=<update_type>

merge_mode *

Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

Допустимые значения:

SAVE — вся ранее переданная информация полностью заменяется новой. Подробно
UPDATE — обновляется только та информация, которую вы загружаете в данный момент. Подробно
APPEND — новая информация добавляется к ранее загруженной. Подробно

^* Обязательный параметр

В теле запроса


--data '{
        "contacts": [
            {
                "uniq_id": "J3QQ4-H7H2V-2HCH4-M3HK8-6M8VW",
                "name": "Иванов И.",
                "create_date_time": "2020-04-17 16:12:21",
                "update_date_time": "2020-04-17 16:12:21",
                "client_ids": [
                    "12345678910",
                    "10987654321"
                ],
                "emails": [
                    "exampl1@example.com",
                    "example2@example.com"
                ],
                "phones": [
                    "78005553535",
                    "73449932378"
                ]
            },
            {
                "uniq_id": "ZYX4-H7H2V-2HCH4-M3HK8-6M8VW",
                "name": "Петрова М.",
                "create_date_time": "2020-05-17 16:13:21",
                "update_date_time": "2020-05-17 16:14:21",
                "client_ids": [
                    "11223344556"
                ]
            }
        ]
    }'


Параметры	Описание
contacts	Список клиентов
contacts
uniq_id	Идентификатор клиента
name	Название клиента. Если вы передаете фамилию, имя и отчество, строка будет сокращена до вида Иванов И..
birth_date	Дата рождения клиента
create_date_time	Дата и время создания контакта в часовом поясе счетчика. Подробно
update_date_time	Дата и время обновления контакта в часовом поясе счетчика. Подробно
client_ids	Список ClientID клиента
user_ids	Список UserID клиента.
emails	Список электронных адресов клиента.
phones	Список телефонных номеров клиента.
emails_md5	Список электронных адресов клиента, хешированных в формате md5.
phones_md5	Список телефонных номеров клиента, хешированных в формате md5.


Параметры	Описание
contacts	Список клиентов
contacts
uniq_id	Идентификатор клиента
name	Название клиента. Если вы передаете фамилию, имя и отчество, строка будет сокращена до вида Иванов И..
birth_date	Дата рождения клиента
create_date_time	Дата и время создания контакта в часовом поясе счетчика. Подробно
update_date_time	Дата и время обновления контакта в часовом поясе счетчика. Подробно
client_ids	Список ClientID клиента
user_ids	Список UserID клиента.
emails	Список электронных адресов клиента.
phones	Список телефонных номеров клиента.
emails_md5	Список электронных адресов клиента, хешированных в формате md5.
phones_md5	Список телефонных номеров клиента, хешированных в формате md5.

Пример запроса

POST https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts?merge_mode=SAVE

Формат ответа


{
    "uploading" : {
        "uploading_id" :  < string > ,
        "datetime" :  < local_date_time > ,
        "api_validation_status" :  < api_validation_status > ,
        "elements_count" :  < integer > ,
        "entity_type" :  < entity_type > ,
        "entity_subtype" :  < string > ,
        "uploading_format" :  < uploading_format > ,
        "uploading_source" :  < uploading_source > 
    }
}


Параметры	Описание
uploading	Информация о загрузке
uploading
uploading_id	Идентификатор загрузки
datetime	Время загрузки
api_validation_status	Статус валидации загрузки Возможные значения: PASSED — Валидация прошла успешно FAILED — Валидация прошла не успешно
elements_count	Количество элементов в загрузке
entity_type	Тип сущности Возможные значения: SYSTEM — Системная сущность, например контакты или заказы CUSTOM_LIST — Пользовательский список SYSTEM_LIST — Системный список, например товары
entity_subtype	Подтип сущности
uploading_format	Формат загрузки Возможные значения: JSON — JSON CSV — CSV
uploading_source	Источник загрузки Возможные значения: API — API


Параметры	Описание
uploading	Информация о загрузке
uploading
uploading_id	Идентификатор загрузки
datetime	Время загрузки
api_validation_status	Статус валидации загрузки Возможные значения: PASSED — Валидация прошла успешно FAILED — Валидация прошла не успешно
elements_count	Количество элементов в загрузке
entity_type	Тип сущности Возможные значения: SYSTEM — Системная сущность, например контакты или заказы CUSTOM_LIST — Пользовательский список SYSTEM_LIST — Системный список, например товары
entity_subtype	Подтип сущности
uploading_format	Формат загрузки Возможные значения: JSON — JSON CSV — CSV
uploading_source	Источник загрузки Возможные значения: API — API