Выгрузка профилей в файл
Описание
Получить информацию о всех профилях подписчиков базы данных или ресурса.
Для получения информации необходимо выполнить несколько запросов: выгрузку данных в файл, проверку статуса задания и загрузку файла.
Шаг 1. Выгрузка данных в файл
URL-адрес
Метод: POST
https://example.com/api/v1.1/profiles/get_all
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
source_type | string | "database" "segment" | Да | Тип источника данных |
source_id | int | 1 | Да | Идентификатор источника данных |
file_format | string | "csv" | Нет | Формат файла для экспорта. По умолчанию - csv. |
custom_request | JSON object | {"occupation":"doctor"} | Нет | Поля профиля для уточнения поиска |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"source_type": "database",
"source_id": 1,
"file_format": "csv"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<source_type>database</source_type>
<source_id>1</source_id>
<file_format>csv</file_format>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"task_id": "task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5"
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<task_id>task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5</task_id>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
task_id | string | Идентификатор задания на экспорт |
error | int | Код ошибки |
error_text | string | Текст ошибки |