Экспорт статусов рассылок

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

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

Контракт экспорта статусов рассылок

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

JSON
POST https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation}
Accept: application/json
Content-Type: application/json
Authorization: SecretKey {Секретный ключ}

{
  "sinceDateTimeUtc": "<Дата и время самого раннего статуса (UTC, YYYY-MM-DD hh:mm)>",
  "tillDateTimeUtc": "<Дата и время самого позднего статуса невключительно (UTC, YYYY-MM-DD hh:mm)>"
}

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

• Дату "от" (sinceDateTimeUtc) в формате UTC. Тогда в выгрузку попадут только статусы созданные в системе после этой даты
• Дату "до" (tillDateTimeUtc) в формате UTC. Тогда в выгрузку попадут только статусы созданные в системе до этой даты

Формат ответа

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

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

Описание базовых полей экспорта

JSON
{
  "customerMessageStatuses": [
    {
      "dateTimeUtc": "<Дата и время статуса рассылки>",
      "ids": {
        "id": "<Идентификатор статуса>"
      },
      "customerMessage": {
        "dateTimeUtc": "<Дата и время участия в рассылке в UTC>",
        "ids": {
          "id": "<Идентификатор участия в рассылке>"
        }
      },
      "mailing": {
        "name": "<Название рассылки>",
        "variantNum": "<Номер варианта рассылки>",
        "link": "<Ссылка>",
        "ids": {
          "id": "<Идентификатор рассылки>"
        },
        "notSentReason": {
          "name": "<Описание статуса, почему рассылка не отправилась>",
          "ids": {
            "systemName": "<Системное имя статуса, почему рассылка не отправилась>"
          }
        },
        "notDeliveredReason": {
          "name": "<Описание статуса, почему рассылка не доставилась>",
          "ids": {
            "systemName": "<Системное имя статуса, почему рассылка не доставилась>"
          }
        },
        "brand": {
          "ids": {
            "systemName": "<Системное имя бренда>"
          }
        },
        "channel": {
          "ids": {
            "systemName": "<Системное имя канала рассылки>"
          }
        }
      },
      "mailingSource": {
        "entityType": "<Тип сущности>",
        "entityId": "<Id сущности>",
        "entityName": "<Имя сущности>"
      },
      "mailingStatus": {
        "ids": {
          "systemName": "<Системное имя статуса рассылки>"
        }
      }
    },
    {
      "dateTimeUtc": "<Дата и время статуса рассылки>",
      "ids": {
        "id": "<Идентификатор статуса>"
      },
      "customerMessage": {
        "dateTimeUtc": "<Дата и время участия в рассылке в UTC>",
        "ids": {
          "id": "<Идентификатор участия в рассылке>"
        }
      },
      "mailing": {
        "name": "<Название рассылки>",
        "variantNum": "<Номер варианта рассылки>",
        "link": "<Ссылка>",
        "ids": {
          "id": "<Идентификатор рассылки>"
        },
        "notSentReason": {
          "name": "<Описание статуса, почему рассылка не отправилась>",
          "ids": {
            "systemName": "<Системное имя статуса, почему рассылка не отправилась>"
          }
        },
        "notDeliveredReason": {
          "name": "<Описание статуса, почему рассылка не доставилась>",
          "ids": {
            "systemName": "<Системное имя статуса, почему рассылка не доставилась>"
          }
        },
        "brand": {
          "ids": {
            "systemName": "<Системное имя бренда>"
          }
        },
        "channel": {
          "ids": {
            "systemName": "<Системное имя канала рассылки>"
          }
        }
      },
      "mailingSource": {
        "entityType": "<Тип сущности>",
        "entityId": "<Id сущности>",
        "entityName": "<Имя сущности>"
      },
      "mailingStatus": {
        "ids": {
          "systemName": "<Системное имя статуса рассылки>"
        }
      }
    }
  ]
}