Copy page

Экспорты

Экспорт клиентов из блоков сценариев

Требования

Настроенная операция с шагом «Экспорт — выгрузить клиентов из отчета прохождения сценария».

Общий контракт постановки задачи экспорта

Общий контракт постановки задачи экспорта описан здесь.

Контракт экспорта клиентов из отчета прохождения сценария

JSON
https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation}

Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

{
  "sinceDate": "<Начало периода>",
  "tillDate": "<Конец периода>",
  "scenarioId": "<Идентификатор сценария>",
  "scenarioVersion": "<Номер версии сценария>",
  "blockId": "<Идентификатор блока>",
  "outputIndex": "<Номер выхода блока>",
  "onlyStartedInPeriod": "<Только попавшие в сценарий за этот период>"
}

Во входных параметрах можно указать:

• Дату «от». В выгрузку попадут только клиенты, прошедшие блок начиная с указанной даты.
• Дату «до». В выгрузку попадут только клиенты, прошедшие блок до указанной даты.
• Номер выхода блока. 1 — соответствует ветке «Да»; 2 — соответствует ветке «Нет».
• Задать настройку, которая выгрузит только тех клиентов, которые попали в сценарий за указанный период. Возможные значения: true, false.

Пример тела ответа

JSON
{
  "status": "<Результат выполнения запроса: Success в случае успеха, ValidationError в случае ошибки пользователя, ProtocolError в случае ошибки интеграции, InternalServerError в случае недоступности сервера.>",
  "exportId": "<Идентификатор экспорта, который нужно передать в следующем запросе>",
  "exportResult": {
    "processingStatus": "<Статус готовности файла>",
    "cancellationReason": "<Причина отмены экспорта>",
    "urls": [
      "<Ссылка на файл с результатом>",
      "<Ссылка на файл с результатом>"
    ]
  }
}

По полученному в ответе операции exportId, файл с выгрузкой клиентов можно скачать в разделе «Задачи» или выгрузить по API.

Для выгрузки по API повторно вызовите операцию, указав в теле запроса полученный при предыдущем запросе exportId.

JSON
https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation}

Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

{
  "exportId": "<Идентификатор экспорта>"
}

Формат выгружаемого файла

В файле будут перечислены MindboxId клиентов, прошедших блок сценария.