Copy page

Экспорты

Экспорт регистраций клиентов

Метод запускает экспорт регистраций клиентов. Результат выгружается в файл формата CSV, JSON или XML — в зависимости от настроек операции. Доступен экспорт на FTP/SFTP-сервер. Общие сведения об экспортах, включая сроки хранения файлов и разбивку по частям, описаны в обзоре экспортов.

Предварительная настройка

В интерфейсе Mindbox настройте операцию с шагом «Экспорт — Выгрузить регистрации клиентов». В настройках шага выберите:

• формат файла: CSV, JSON или XML;
• поля регистрации, данные клиента и данные связанного действия, которые нужно выгрузить, — подробнее в разделе Состав выгрузки;
• сегмент клиентов, если нужно выгружать регистрации только клиентов из этого сегмента. Сегмент также можно передать в запросе.

Для доступа к файлу экспорта нужно право «Экспорт регистраций клиентов».

Запрос

URL

POST https://{Домен API}/v3/operations/sync?endpointId={Идентификатор точки интеграции}&operation={Название операции}

Заголовки

Тело запроса

JSON
{
  "exportId": "<Идентификатор экспорта>",
  "sinceDateTimeUtc": "<Начальная дата и время в UTC>",
  "tillDateTimeUtc": "<Конечная дата и время в UTC>",
  "brand": {
    "ids": {
      "systemName": "<Системное имя бренда>"
    }
  },
  "segment": {
    "ids": {
      "externalId": "<Внешний идентификатор сегмента клиентов>"
    }
  },
  "pointsOfContact": [
    {
      "ids": {
        "externalId": "<Внешний идентификатор точки контакта>",
        "systemName": "<Системное имя точки контакта>"
      }
    }
  ],
  "pointOfContactChannels": [
    {
      "ids": {
        "externalId": "<Внешний идентификатор канала>",
        "systemName": "<Системное имя канала>"
      }
    }
  ]
}

Параметры тела запроса

Все параметры необязательные. Если не передать ни одного фильтра, выгрузятся все регистрации на проекте.

Период отбирается по дате создания регистрации в системе (creationDateTimeUtc). Это дата, когда Mindbox обработал регистрацию. Фактически регистрация могла произойти в другое время — эта дата выгружается в dateTimeUtc. Учитывайте это, когда задаете период в запросе.

Регистрация попадает в выгрузку, если:

sinceDateTimeUtc ≤ дата создания регистрации в системе < tillDateTimeUtc

Если передать точки контакта и каналы одновременно, выгрузятся регистрации, действие которых совершено в одной из перечисленных точек контакта или в точке контакта одного из перечисленных каналов.

Пример запроса

Запрос выгружает регистрации за сентябрь 2026 года, которые появились в одной из двух точек контакта: первая указана внешним идентификатором, вторая — системным именем.

JSON
POST https://api.mindbox.ru/v3/operations/sync?endpointId=Website&operation=Export.CustomerRegistrations

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

{
  "sinceDateTimeUtc": "2026-09-01 00:00:00.000",
  "tillDateTimeUtc": "2026-10-01 00:00:00.000",
  "pointsOfContact": [
    { "ids": { "externalId": "Android" } },
    { "ids": { "systemName": "Website" } }
  ]
}

Ответ

Параметры ответа

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

• Первый запрос — экспорт поставлен в очередь:

JSON
{
  "status": "Success",
  "exportId": "23764"
}

• Запрос с такими же параметрами, пока предыдущий экспорт еще формируется, — новый экспорт не ставится в очередь, возвращается идентификатор уже запущенного:

JSON
{
  "status": "Success",
  "exportId": "23764",
  "isDuplicate": true
}

• Повторный запрос с exportId — файл готов:

JSON
{
  "status": "Success",
  "exportResult": {
    "processingStatus": "Ready",
    "urls": [
      "export.csv"
    ]
  }
}

Значения status

Значения processingStatus

Обработка ошибок

Состав выгрузки

Формат файла (CSV, JSON или XML) зависит от настроек операции. Одна запись в файле — одна регистрация клиента.

В выгрузку всегда включаются:

• Mindbox ID клиента (customer.ids.mindboxId);
• бизнес-дата и время регистрации (dateTimeUtc).

Опционально выгружаются поля, выбранные в настройках шага. В блоке «Запись регистрации»:

• «Дата и время создания в системе» — дата и время создания регистрации в системе;
• «Бренд»;
• «Механика регистрации (тип, ID, название)» — механика, в рамках которой появилась регистрация;
• «Персонал» — логин сотрудника, который зарегистрировал клиента;
• «Связанное действие» — действие, в котором у клиента появился контакт или идентификатор.

В блоке «Данные клиентов» — базовая информация, email и телефон, внешние идентификаторы клиентов, последняя активированная карта, дополнительные поля. Поля могут отсутствовать, если они пустые в карточке клиента.

В блоке «Действия регистрации» — базовая информация, связанные продукты и категории продуктов, изменения баланса, связанные промокоды, дополнительные поля, состояние заказа, статус дисконтной карты, персонал, связанные клиенты. Блок доступен, если отмечено «Связанное действие». Поля действия описаны в статье Экспорт действий клиентов. Например, для регистрации из импорта заказов в customerAction.order выгружается связанный заказ с позициями.

Механика регистрации

В mechanics.type выгружается системное имя типа механики, в рамках которой появилась регистрация, например:

Список не полный: регистрация может появиться и в других механиках.

Структура данных

JSON
{
  "customerRegistrations": [
    {
      "customer": {
        "ids": {
          "mindboxId": "<Идентификатор клиента в Mindbox>",
          "<системное_имя_идентификатора>": "<Внешний идентификатор>"
        },
        "lastName": "<Фамилия>",
        "firstName": "<Имя>",
        "middleName": "<Отчество>",
        "email": "<Адрес электронной почты>",
        "mobilePhone": "<Номер мобильного телефона>",
        "customFields": {
          "<системное_имя_поля>": "<Значение дополнительного поля>"
        },
        "lastActivatedCard": {
          "ids": {
            "number": "<Номер дисконтной карты>"
          }
        }
      },
      "dateTimeUtc": "<Бизнес-дата и время регистрации в UTC>",
      "creationDateTimeUtc": "<Дата и время создания регистрации в системе в UTC>",
      "brand": {
        "ids": {
          "systemName": "<Системное имя бренда>"
        }
      },
      "mechanics": {
        "type": "<Системное имя типа механики>",
        "id": "<Идентификатор механики>",
        "name": "<Название механики>"
      },
      "staff": {
        "userName": "<Логин сотрудника>"
      },
      "customerAction": {
        "ids": {
          "mindboxId": "<Идентификатор действия в Mindbox>"
        },
        "actionTemplate": {
          "ids": {
            "systemName": "<Системное имя шаблона действия>"
          }
        },
        "dateTimeUtc": "<Дата и время действия в UTC>"
      }
    }
  ]
}

Поля файла CSV

Названия колонок CSV собираются из пути к полю в JSON с префиксом CustomerRegistration. Например, customer.ids.mindboxId → CustomerRegistrationCustomerIdsMindboxId.