Обновлено: 10.08.2026

Экспорт данных

Выгрузка сегментов, заказов и статистики в CSV для отчётов и внешних систем. Экспорт — асинхронная задача: создаёте job, опрашиваете статус, скачиваете файл по готовности.

Обзор методов

Метод	Путь	Описание
`POST`	`/exports`	Создать задачу экспорта
`GET`	`/exports/{id}`	Статус и ссылка на файл
`GET`	`/exports`	История экспортов
`DELETE`	`/exports/{id}`	Отменить задачу экспорта

Создать задачу экспорта

Эндпоинт

POST /exports

Ставит выгрузку в очередь. Поддерживаемые типы: users, orders, segment_users.

Параметры

Параметр	Где	Тип	Обязателен	Описание
`type`	`тело`	string	да	Тип выгрузки: users, orders или segment_users.
`segment_id`	`тело`	string	нет	Обязателен при type = segment_users.

Запрос

curl https://api.virazh.io/v1/exports \
  -X POST \
  -H "Authorization: Bearer sk_test_51H..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "segment_users", "segment_id": "seg_active_fans" }'

Ответ

{
  "export_id": "exp_4471",
  "status": "processing"
}

Поля ответа

Поле	Тип	Описание
`export_id`	`string`	Идентификатор задачи экспорта.
`status`	`string`	processing сразу после создания.

Статус и ссылка на файл

Эндпоинт

GET /exports/{id}

Готовый файл доступен по временной ссылке в течение 24 часов.

Параметры

Параметр	Где	Тип	Обязателен	Описание
`id`	`путь`	string	да	Идентификатор задачи экспорта.

Запрос

curl https://api.virazh.io/v1/exports/exp_4471 \
  -H "Authorization: Bearer sk_test_51H..."

Ответ

{
  "export_id": "exp_4471",
  "status": "done",
  "file_url": "https://files.virazh.io/exports/exp_4471.csv",
  "expires_at": "2026-08-26T12:00:00Z"
}

Поля ответа

Поле	Тип	Описание
`status`	`string`	processing, done или failed.
`file_url`	`string \| null`	Ссылка на CSV-файл, доступна при status = done.
`expires_at`	`string (ISO 8601) \| null`	Момент истечения ссылки на файл.

История экспортов

Эндпоинт

GET /exports

Список ранее запущенных задач экспорта с их статусом — для панели «Мои выгрузки».

Запрос

curl https://api.virazh.io/v1/exports \
  -H "Authorization: Bearer sk_test_51H..."

Ответ

{
  "data": [
    { "id": "exp_4471", "type": "segment_users", "status": "done" },
    { "id": "exp_4472", "type": "orders", "status": "processing" }
  ]
}

Поля ответа

Поле	Тип	Описание
`data`	`array<ExportSummary>`	Задачи с полями id, type, status.

Отменить задачу экспорта

Эндпоинт

DELETE /exports/{id}

Отменяет выгрузку в статусе processing. Готовые (done) задачи отменить нельзя — только скачать или дождаться истечения ссылки.

Параметры

Параметр	Где	Тип	Обязателен	Описание
`id`	`путь`	string	да	Идентификатор задачи экспорта.

Запрос

curl https://api.virazh.io/v1/exports/exp_4472 \
  -X DELETE \
  -H "Authorization: Bearer sk_test_51H..."

Ответ

{
  "export_id": "exp_4472",
  "status": "cancelled"
}

Поля ответа

Поле	Тип	Описание
`export_id`	`string`	Идентификатор задачи.
`status`	`string`	cancelled при успешной отмене.

Полезно знать

Экспорт — асинхронная задача: сразу после создания status почти всегда processing, опрашивайте /exports/{id} с интервалом от 3–5 секунд, а не сразу же в цикле.
Ссылка на файл живёт 24 часа — если нужно постоянное хранилище, скачайте файл на свою сторону сразу после status: done.
Один клуб может держать не более 5 незавершённых задач экспорта одновременно — лишние запросы вернут 429 rate_limited.
Подпишитесь на вебхук export.completed, чтобы не опрашивать статус по таймеру вообще — платформа сама уведомит о готовности файла.

Документация «Вираж»

Экспорт данных

Обзор методов

Создать задачу экспорта

Статус и ссылка на файл

История экспортов

Отменить задачу экспорта

Полезно знать