×

Получи 5 готовых email-стратегий для любого бизнеса БЕСПЛАТНО!

После регистрации

меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

[New] Метод getCampaignDeliveryStats

Получить отчёт по результатам доставки сообщений в заданной рассылке.

Принцип использования

Пользователь присылает запрос на получение отчета

async/getCampaignDeliveryStats — запрос на получение отчета по доставке

URL для вызова метода
https://api.unisender.com/ru/api/async/getCampaignDeliveryStats
Аргументы
api_key * Ключ доступа к API.
campaign_id * Идентификатор кампании, полученный при вызове метода createCampaign.
notify_url * URL, на который будет отправлен ответ после того, как отчет будет сформирован.
field_ids Массив id дополнительных полей. Способ передачи с помощью HTTP: field_ids[]=1&field_ids[]=2. Значения id можно получить используя метод getFields. Если указан, в результат добавляются значения дополнительных полей, связанных с контактом.
Возвращаемое значение
JSON-объект со следующим полями:
{
  "result":{
    "task_uuid": "ff719cf2-4ed9-11e9-8647-d663bd873d93",
    "status": "new",
  }
}
task_uuid Уникальный идентификатор задания на подготовку данных.
status Статус выполнения задания.

Система готовит данные

В зависимости от количества получателей в рассылке, отчет по ней может готовиться какое-то время. После того, как отчет будет готов, он будет отправлен на URL, указанный в параметре notify_url метода async/getCampaignDeliveryStats.

Также можно запросить статус подготовки отчета:

Запросить статус выполнения задания

async/getTaskResult — получить статус задания

URL для вызова метода
https://api.unisender.com/ru/api/async/getTaskResult
Аргументы
api_key * Ключ доступа к API.
task_uuid * Идентификатор запроса на подготовку отчета, полученный при вызове метода async/getCampaignDeliveryStats.

Если  задание еще выполняется:

Возвращаемое значение
JSON-объект со следующим полями:
{
  "result":{
    "task_uuid": "ff719cf2-4ed9-11e9-8647-d663bd873d93",
     "task_type": "getCampaignDeliveryStats",
     "status": "processing"
  }
}
task_uuid Уникальный идентификатор задания на подготовку данных.
task_type Тип задания на подготовку данных.
Метод getTaskResult — универсальный и подходит для методов, где используется подготовка данных. В параметре возвращается название метода, по которому выполняется подготовка задания. В данном случае возвращается метод async/getCampaignDeliveryStats.
status Статус выполнения задания.

Если задание уже выполнено:

Возвращаемое значение
JSON-объект со следующим полями:
{
  "result":{
        "task_uuid": "ff719cf2-4ed9-11e9-8647-d663bd873d93",
        "task_type": "exportContacts",
        "status": "completed",
        "file_to_download": "[URL to AWS]"
  }
}
task_uuid Уникальный идентификатор задания на подготовку данных.
task_type Тип задания на подготовку данных.
Метод getTaskResult — универсальный и подходит для методов, где используется подготовка данных. В параметре возвращается название метода, по которому выполняется подготовка задания. В данном случае возвращается метод async/getCampaignDeliveryStats.
status Статус выполнения задания.
file_to_download Ссылка на скачивание файла.

Система отправляет пользователю нотификацию со ссылкой на запрошенные данные

После выполнения задания на подготовку данных система отправляет пользователю Webhook на указанный URL (параметр notify_url)

Отправляемая нотификация
JSON-объект со следующим полями:
{
  "result":{
        "task_uuid": "ff719cf2-4ed9-11e9-8647-d663bd873d93",
        "task_type": "exportContacts",
        "status": "completed",
        "file_to_download": "[URL to AWS]"
  }
}
task_uuid Уникальный идентификатор задания на подготовку данных.
task_type Тип задания на подготовку данных.
Метод getTaskResult — универсальный и подходит для методов, где используется подготовка данных. В параметре возвращается название метода, по которому выполняется подготовка задания. В данном случае возвращается метод async/getCampaignDeliveryStats.
status Статус выполнения задания.
file_to_download Ссылка на скачивание файла.

Примеры формирования URL-запроса

https://api.unisender.com/ru/api/async/getCampaignDeliveryStats?api_key=KEY
— запрос на получение отчета по доставке.

Предыдущая версия метода getCampaignDeliveryStats (будет поддерживаться до 01.07.2019)