Получение всех импортов
Описание
Возвращает список импортов для аудитории и общее количество импортов. Подходит для просмотра истории заданий импорта и постраничного вывода через limit и offset.
URL-адрес
GET
/audience/imports/{aid}Параметры запроса
| Параметр | Где | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|---|
| aid | path | integer | 42 | Да | Идентификатор аудитории |
| limit | query | integer | 50 | Нет | Сколько импортов вернуть за запрос |
| offset | query | integer | 0 | Нет | Смещение для постраничного получения |
Пример запроса
bash
curl -X GET "https://example.com/api/audience/imports/42?limit=50&offset=0" \
-H "X-MOODREC-API: <token>" \
-H "Accept: application/json"
Пример ответа
json
{
"imports": [
{
"aid": 42,
"import_id": 101,
"name": "Импорт аудитории",
"description": "Обновление из файла",
"status": "success",
"option": {
"url": "https://example.ru/segment.csv",
"action": "upsert",
"overwriteType": true,
"priority": {
"email": 10
},
"skip_rows": 1,
"column_mapping": [
{
"ext_num": 0,
"ext_name": "email",
"int_name": "email",
"is_hashed": false
}
]
},
"auth_options": {
"type": "none",
"login": "user",
"password": "password",
"token": "example-token"
},
"task_options": {
"task_id": "example-task-id",
"start_objects": [
{
"hours": 1,
"minutes": 15
}
],
"start_type": {
"is_interval": false,
"interval": 15,
"time_type": "minutes",
"is_regular": true,
"start_time": 1740125112,
"weekdays": [0, 1, 2, 3]
}
}
}
],
"count": 1
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| imports | array | Список импортов аудитории |
| imports[].aid | integer | Идентификатор аудитории |
| imports[].import_id | integer | Идентификатор импорта |
| imports[].name | string | Название импорта |
| imports[].description | string | Описание импорта |
| imports[].status | string | Статус импорта |
| imports[].option | object | Параметры источника и мапинга данных |
| imports[].option.url | string | URL файла-источника |
| imports[].option.action | string | Действие над данными (например, upsert, full_update, delete) |
| imports[].option.column_mapping | array | Настройки мапинга колонок |
| imports[].option.column_mapping[].ext_num | integer | Индекс колонки в файле |
| imports[].option.column_mapping[].ext_name | string | Название колонки в файле |
| imports[].option.column_mapping[].int_name | string | В какое поле мапить |
| imports[].option.column_mapping[].is_hashed | boolean | Признак, что значения уже хешированы (SHA-256) |
| imports[].option.overwriteType | boolean | Перезаписывать типы полей при конфликте |
| imports[].option.priority | object | Приоритеты полей (большее число — выше приоритет) |
| imports[].option.skip_rows | integer | Пропуск первой строки/наличие заголовков (0 или 1) |
| imports[].auth_options | object | Параметры доступа к файлу-источнику |
| imports[].auth_options.type | string | Тип авторизации (например, basic, token, none) |
| imports[].auth_options.login | string | Логин |
| imports[].auth_options.password | string | Пароль |
| imports[].auth_options.token | string | Токен доступа |
| imports[].task_options | object | Параметры запуска задачи импорта |
| imports[].task_options.task_id | string | Идентификатор задачи |
| imports[].task_options.start_objects | array | Временные параметры запуска |
| imports[].task_options.start_objects[].hours | integer | Часы |
| imports[].task_options.start_objects[].minutes | integer | Минуты |
| imports[].task_options.start_type | object | Настройки расписания запуска |
| imports[].task_options.start_type.is_interval | boolean | Запуск по интервалу |
| imports[].task_options.start_type.interval | integer | Интервал запуска |
| imports[].task_options.start_type.time_type | string | Единицы интервала (minutes, hours) |
| imports[].task_options.start_type.is_regular | boolean | Регулярный запуск |
| imports[].task_options.start_type.start_time | integer | Время старта в Unix |
| imports[].task_options.start_type.weekdays | array | Дни недели |
| count | integer | Общее количество импортов |