AISARAISAR
REST API

Экспорт

Асинхронный экспорт данных компании — контактов, сообщений или сегментов — в CSV, XLSX или JSON. Запрос ставит задачу в очередь и сразу возвращает объект экспорта в статусе `pending`; готовность отслеживается через `GET /exports/{id}`, файл скачивается по `download_url` после перехода в `completed`. Экспорт типа `messages` ограничен пятью запусками в сутки на компанию.

Эндпоинты

МетодПуть
GET/v1/exports

Список экспортов

POST/v1/exports

Создание экспорта

GET/v1/exports/{export}

Получение экспорта (статус, размер, кол-во строк)

GET/v1/exports/{export}/download

Скачивание готового файла экспорта

DELETE/v1/exports/{export}

Удаление экспорта

Примеры

Создание экспорта контактов

Запрос

bash
curl -X POST https://api.aisar.app/v1/exports \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "contacts",
    "format": "csv",
    "filters": { "segment_id": 12 }
  }'

Ответ

json
{
  "data": {
    "message": "Export started.",
    "export": {
      "id": 301,
      "uuid": "9f1c2e40-6b3a-4e9e-9d2a-1f7a8c0b5d21",
      "type": "contacts",
      "name": "Contacts export",
      "format": "csv",
      "status": "pending",
      "filters": { "segment_id": 12 },
      "row_count": null,
      "file_size": null,
      "error_message": null,
      "download_url": null,
      "expires_at": "2026-03-22T10:00:00.000000Z",
      "created_at": "2026-03-15T10:00:00.000000Z",
      "updated_at": "2026-03-15T10:00:00.000000Z"
    }
  }
}

Проверка статуса экспорта

Запрос

bash
curl https://api.aisar.app/v1/exports/301 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Ответ

json
{
  "data": {
    "id": 301,
    "uuid": "9f1c2e40-6b3a-4e9e-9d2a-1f7a8c0b5d21",
    "type": "contacts",
    "name": "Contacts export",
    "format": "csv",
    "status": "completed",
    "filters": { "segment_id": 12 },
    "row_count": 340,
    "file_size": 48213,
    "error_message": null,
    "download_url": "https://api.aisar.app/v1/exports/301/download",
    "expires_at": "2026-03-22T10:00:00.000000Z",
    "created_at": "2026-03-15T10:00:00.000000Z",
    "updated_at": "2026-03-15T10:02:31.000000Z"
  }
}