Получить статистику по авторассылке
Чтобы получить информацию по авторассылке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID} |
Параметры запроса в URL:
ID | идентификатор созданной авторассылки (можно взять из URL просмотра авторассылки) |
Пример ответа:
{
"autoresponder": {
"id": 281013, // идентификатор авторассылки
"name": "Новая авторассылка 2020-06-23", // название авторассылки
"status": 1,
"created": "2020-06-23 11:06:25", // время создания авторассылки
"changed": "2020-06-23 11:06:25" // время последних изменений в авторассылке
},
"flows": [
{
"id": 467510, // идентификатор блока, используется для методов получения статистики
"main_id": 281013, // идентификатор авторассылки, к которой принадлежит блок (совпадает с значением из URL в личном кабинете при просмотре)
"af_type": "maintrigger", // тип блока, описание смотри ниже
"created": "2020-06-23 14:06:25", // время создания блока
"last_send": "2020-06-25 17:05:40", / время последнего действия блока
"task": null
},
{
"id": 467511,
"main_id": 281013,
"af_type": "email",
"created": "2020-06-23 14:06:25",
"last_send": "2020-06-25 17:05:41",
"task": {
"id": 12018943, // идентификатор рассылки
"address_book_id": 0, // идентификатор книги, по которой старт; если старт по событию, ид будет равен 0
"message_title": "Спасибо за заказ, 7136062", // тема письма
"sender_mail_address": "smtp_test@e.cn.ua", // адрес отправителя
"sender_mail_name": "smtp_test", // имя отправителя
"created": "2020-06-23 14:06:25" // дата создания
}
},
{
"id": 486649,
"main_id": 281013,
"af_type": "push",
"created": "2020-07-09 15:40:12",
"last_send": null,
"task": {
"id": 3016415, // идентификатор пуш рассылки
"website_id": 14699, // идентификатор сайта
"title": "заголовок для пуш",
"body": "текст пуш уведомления",
"icon": "/files/push/7023639/tasks/3016415/icons/577416720c24.png", // иконка сайта
"url_for_click": "https://google.com", // ссылка в рассылке
"created": "2020-07-09 15:40:12" // дата создания пуш рассылки
}
},
{
"id": 486657,
"main_id": 281013,
"af_type": "sms",
"created": "2020-07-09 15:48:22",
"last_send": null,
"task": {
"id": 12110431, // идентификатор смс рассылки
"address_book_id": 0, // идентификатор книги, по которой старт; если старт по событию, ид будет равен 0
"sms_body": "текст смс уведомления", // текст смс рассылки
"sms_sender_name": "Bakler", // имя отправителя
"created": "2020-07-09 15:48:22" // дата создания смс рассылки
}
}
],
"starts": 18, // количество стартов авторассылки
"in_queue": 0, // количество подписчиков в очереди по настроенным блокам
"end_count": 18, // количество подписчиков завершивших цепочку
"send_messages": 16, // количество отправленных сообщений со всей цепочки
"conversions": 0 // количество выполненных конверсий
}
Возможные статусы авторассылки:
Код | Описание |
0 | новая |
1 | активная |
3 | пауза |
Возможные типы блоков в авторассылке:
Тип блока | Описание |
maintrigger | стартовый блок |
trigger | блок "условие" |
sms | блок "смс" |
push | блок "push" |
блок "email" | |
action | блок "действие" |
filter | блок "фильтр" |
goal | блок "цель" |
Обратите внимание, что все даты, которые получаете в ответе по API отдаются по настроенному часовому поясу в аккаунте.
Чтобы получить группированную статистику по авторассылке за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример ниже); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример JSON строки параметра filter до кодирования:
{
"type":"group",
"expression":"and",
"fields":{ //Массив с фильтрам
"send_date_from":{ //Фильтр по дате, поиск статистики начиная с конкретной даты
"name":"user_stat_date",
"expression":"gte",
"value":"2020-10-01"
},
"send_date_to":{ //Фильтр по дате, поиск статистики заканчивая датой
"name":"user_stat_date",
"expression":"lte",
"value":"2020-10-31"
}
}
}
Пример параметра filter с кодированной JSON строкой (URL encode):
%7B%22type%22:%22group%22,%22expression%22:%22and%22,%22fields%22:%7B%22send_date_from%22:%7B%22name%22:%22user_sent_date%22,%22expression%22:%22gte%22,%22value%22:%222020-10-01%22%7D,%22send_date_to%22:%7B%22name%22:%22user_sent_date%22,%22expression%22:%22lte%22,%22value%22:%222020-10-31%22%7D%7D%7D
Получить статистику по всем блокам
Чтобы получить статтистику по всем блокам в авторассылке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/total-stats |
Параметры запроса в URL:
ID | идентификатор созданной авторассылки |
flow_type | укажите тип блока, чтобы ограничить вывод результатов; может принимать значения maintrigger (стартовый блок), email , push , sms , filter , action (действие), goal (цель), trigger (условие); необязательный параметр |
Пример запроса с дополнительными параметрами:
https://api.sendpulse.com/a360/autoresponders/{ID}/total-stats?flow_type=type_name |
Пример ответа:
{
"autoresponder": {
"id": 292692,
"name": "Новая авторассылка 2020-11-23",
"status": 1,
"created": "2020-11-23 08:42:47",
"changed": "2020-11-23 08:42:47"
},
"flows": [
{
"type": "maintrigger",
"flow_id": 641433,
"executed": 3,
"deleted": 0,
"last_send": "2020-11-23 10:52:00"
},
{
"type": "filter",
"flow_id": 641434,
"executed": 3,
"positive": 1,
"negative": 1,
"stopped": 1,
"last_send": "2020-11-23 10:52:00"
},
{
"type": "goal",
"flow_id": 641435,
"executed": 1,
"last_send": "2020-11-23 10:48:54"
},
{
"type": "action",
"flow_id": 641436,
"executed": 1,
"last_send": "2020-11-23 10:48:54"
},
{
"type": "sms",
"flow_id": 641437,
"executed": 1,
"sent": 0,
"delivered": 0,
"errors": 0,
"last_send": null
},
{
"type": "email",
"flow_id": 641438,
"sent": 3,
"error": 0,
"opened": 0,
"clicked": 0,
"marked_as_spam": 0,
"unsubscribed": 0,
"delivered": 3,
"last_send": "2020-11-23 10:52:00"
},
{
"type": "push",
"flow_id": 641439,
"sent": 0,
"delivered": 0,
"clicked": 0,
"errors": 0,
"last_send": null
}
]
}
Получить статистику стартового блока
Чтобы получить общую статистику по стартовому блоку в цепочке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/main-trigger/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data":{
"flow_id": {ID},// идентификатор блока
"executed":1, // сколько раз он запускался
"deleted":0 // сколько подписчиков удалено из цепочки
}
}
Чтобы получить группированную статистику по стартовому блоку в цепочке за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/main-trigger/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": {
"executed": "22", // Кол-во стартов
"deleted": "1", // Кол-во подписчиков удаленных подписчиков
"last_send": "2020-10-13 07:28:28" //Дата последней отправки
}
}
Чтобы получить список адресов попавших на старт цепочки, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/main-trigger/{ID}/addresses?limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortField | параметр сортировки по полю id |
Пример ответа:
{
"data": [
{
"flow_id": {ID},// идентификатор блока
"email": "email подписчика",
"phone": "телефон подписчика",
"event_id": "{EVENT_ID}", // уникальный идентификатор подписчика в цепочке
"email_b64": "EMAIL IN BASE64 ENCODE",
"execution_date": "Время попадания подписчика в цепочку"
}
],
"total": 1 // сколько всего раз запускалась цепочка
}
Получить статистику Email блока
Чтобы получить группированную статистику по блоку "Email" в цепочке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/email/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": 467511, // идентификатор блока
"task": {
"id": 12018943, // идентификатор рассылки
"address_book_id": 0, // идентификатор книги, по которой старт; если старт по событию, ид будет равен 0
"message_title": "Спасибо за заказ, 7136062", // тема письма
"sender_mail_address": "smtp_test@e.cn.ua", // адрес отправителя
"sender_mail_name": "smtp_test", // имя отправителя
"created": "2020-06-23 14:06:25" // дата создания
},
"sent": 16, // сколько было отправлено писем
"delivered": 16, // сколько было доставлено писем
"opened": 16, // сколько открыто писем
"clicked": 0, // сколько было переходов
"errors": 0, // сколько было ошибок
"unsubscribed": 0, // сколько было отписок
"marked_as_spam": 0, // сколько подписчиков пожаловались на спам
"last_send": "2020-06-25 17:05:41" // время последней отправки
}
}
Чтобы получить группированную статистику по блоку "Email" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/email/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data":{
"sent":"10",
"errors":"0",
"opened":"9",
"clicked":"10",
"marked_as_spam":"0",
"unsubscribed":"0",
"delivered":"0",
"last_send":"2020-10-13 07:29:07"
}
}
Чтобы получить список адресов кому отправились письма, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/email/{ID}/addresses?&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": [
{
"id": 151880841, // идентификатор отправки
"email": "EMAIL", // email
"email_b64": "BASE64 EMAIL", // email in base64_encode
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный идентификатор запуска подписчика
"delivered_status": 1, // статус доставки, будет ниже
"delivered_status_description": "sent" // описание статуса доставки
"is_spam": 0, // была ли жалоба на спам, если 0 - не было, если 1 - была
"is_unsubscribe": 0, // была ли отписка, если 0 - не было, если 1 - была
"phone": PHONE, // телефон подписчика, если его не было то будет null
"sent_date": "2020-04-09 11:17:43", // дата отправки
"delivered_date": "2020-04-09 11:17:47", // дата получения статуса о доставке( если даже адрес не существует то эта дата выставляется)
"open_date": null, // дата открытия, если не открыто то null, если открыто то покажет дату
"redirect_date": null, // дата перехода, если не было перехода то null, если был то покажет дату
"updated": "2020-04-09 11:17:47" // дата последнего обновления
}
],
"total": 1 //
}
Описание статусов:
Код | Статус | Описание |
0 | no_status | отправлено |
1 | delivered | доставлено |
2 | deliveryfailed | доставка не удалась по иным причинам |
3 | unsubscribe | отписался от рассылки |
4 | rejectedyus | отключено сервисом |
5 | brokenemail | неправильный адрес |
6 | tmpanavailable | временно недоступный |
7 | emailnotexist | адрес не существует |
8 | serverspam | сервел отклонил письмо как спам |
9 | userspam | пользователь пожаловался на спам |
10 | mboxfull | ящик переполнен |
11 | domainnotexist | домен не существует |
12 | no_status | отправлено |
13 | no_status | отправлено |
14 | badrecipient | плохой получатель, попытки отправки не было |
Получить статистику Push блока
Чтобы получить группированную статистику по блоку "Push", отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/push/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // идентификатор блока
"sent": 9, // сколько было отправлено
"delivered": 3, // сколько доставлено
"clicked": 6, // сколько переходов
"errors": 0, // сколько ошибок
"last_send": "2020-02-28 12:18:23" // дата последней отправки
}
}
Чтобы получить группированную статистику по блоку "Push" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/push/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data":{
"sent":"10",
"delivered":"0",
"clicked":"9",
"errors":"10",
"last_send":"2020-10-13 07:29:07"
}
}
Чтобы получить список подписчиков, кому отправились пуши, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/push/{ID}/addresses?limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
filter | кодированная JSON строка с параметрами даты, см. пример ниже |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": [
{
"id": 424633, // идентификатор отправки
"email": "EMAIL", // email подписчика
"email_b64": "BASE64 EMAIL", // email закодированный в base64
"event_id": "3cc000ab9cff4d41f9fc8d025be2b766", // уникальный идентификатор запуска цепочки
"phone": null, // телефон подписчика
"status": 0, // статус будет ниже
"is_sent": 1, // 1 - отправлено, 0 - не отправлено
"is_delivered": 0, // 1 - доставлено, 0 - не доставлено
"is_redirected": 0, // 1 - был переход, 0 - не было перехода
"sent_date": "2020-02-28 12:18:23" // дата отправки
}
],
"total": 1 // сколько всего записей в этом блоке
}
Описание статусов:
Код | Описание |
0 | Отправлено |
1 | Подписчик отписался |
Получить статистику SMS блока
Чтобы получить группированную статистику по блоку "SMS", отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/sms/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // идентификатор блока
"executed": 2, // сколько всего выполнений блока
"sent": 2, // сколько всего отправлено
"delivered": 2, // сколько доставлнео
"opened": null, // сколько открыто
"clicked": null, // сколько переходов
"errors": 0, // сколько ошибок
"last_send": "2020-04-09 11:17:44" // дата последний отправки
}
}
Чтобы получить группированную статистику по блоку "SMS" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/sms/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data":{
"sent":"10",
"executed":"0",
"delivered":"9",
"errors":"10",
"last_send":"2020-10-13 07:29:07"
}
}
Чтобы получить список подписчиков, кому отправились смс сообщения, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/sms/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=id |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortDirection | параметр сортировки, asc - от большего к меньшему, desc - от меньшего к большему |
sortField | параметр сортировки по полю id |
Пример ответа:
{
"data": [
{
"id": 2214741, // уникальный идентификатор отправки
"phone": PHONE, //номер телефона, присутствует всегда, приведенный в международный формат
"status": 2, // статус отправки, будет ниже
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный идентификатор запуска цепочки
"sender": "sendpulse", // имя отправителя
"body": "BODY", // текст отправки с подставленными переменными
"price": { // цены за смс сообщение в разных валютах
"USD": "0.07900",
"RUR": "4.50000",
"UAH": "1.93000",
"EUR": "0.06400",
"GBP": "0.05600",
"BRL": "0.26000",
"BYN": "0.16000",
"KZT": "22.50000",
"MXN": "1.49000",
"CLP": "60.44000",
"NGN": "30.35000"
},
"cur": "USD", // текущая валюта пользователя. День списываются в валюте на момент отправки
"email": "EMAIL", // email присутствует не всегда
"sent_date": "2020-04-09 11:17:44" // время отправки
}
],
"total": 1 // сколько всего отправок было
}
Описание статусов:
Код | Описание |
0 | отправлено |
1 | не доставлено |
3 | доставлено |
4 | неправильный номер телефона |
5 | провайдер отметил как спам |
6 | дубликат смс |
7 | идет обновление статистики |
Получить статистику блока "Фильтр"
Чтобы получить группированную статистику по блоку "Фильтр" переменных, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/filter/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // идентификатор блока
"executed": 2, // количество выполнений блока
"last_send": "2020-04-09 11:17:44" // время последнего выполнения
}
}
Чтобы получить группированную статистику по блоку "Фильтр" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/filter/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
{
"data": {
"executed": 4, // Кол-во выполнений блока "Фильтр"
"positive": 3, // Кол-во выполнений в "Да"
"negative": 1, // Кол-во выполнений в "Нет"
"stopped": 0, // Кол-во остановок блока
"last_send": "2020-10-06 13:38:56" // Дата последней отправки
}
}
Пример ответа:
Обратите внимание, что параметры "positive", "negative", "stopped" — новые параметры, созданные 30.11.2020. Статистика по ним будет собираться, начиная с 30.11.2020.
Статистика по параметрам "executed" и "last_send" отдается за все время.
Чтобы получить список подписчиков, для кого выполнялся фильтр, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortDirection | параметр сортировки, asc - от большего к меньшему, desc - от меньшего к большему |
sortField | параметр сортировки по полю дата выполнения |
Пример ответа:
{
"data": [
{
"email": "EMAIL", // email подписчика
"email_b64": "BASE64 EMAIL", // email закодированный в base64
"phone": PHONE, // номер телефона подписчика
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный индентификатор запуска цепочки.
"execution_date": "2020-04-09 11:17:44" // время выполнения
}
],
"total": 1 // сколько всего выполнений
}
Получить статистику блока "Условие"
Чтобы получить группированную статистику по блоку "Условие", отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/trigger/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // ид блока
"executed": 2, // к-во выполнений блока
"last_send": "2020-04-09 11:17:44" // время последнего выполнения
}
}
Чтобы получить группированную статистику по блоку "Условие" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/trigger/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
{
"data": {
"executed": "5", // Кол-во выполнений блока "Условие"
"positive": "5", // Кол-во выполнений в "Да"
"negative": "0", // Кол-во выполнений в "Нет"
"last_send": "2020-10-18 12:36:38" // Дата последней отправки
}
}
Пример ответа:
Обратите внимание, что параметры "positive", "negative", "stopped" — новые параметры, созданные 30.11.2020. Статистика по ним будет собираться, начиная с 30.11.2020.
Статистика по параметрам "executed" и "last_send" отдается за все время.
Чтобы получить список адресов, для кого выполнялось условие, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortDirection | параметр сортировки, asc - от большего к меньшему, desc - от меньшего к большему |
sortField | параметр сортировки по полю дата выполнения |
Пример ответа:
{
"data": [
{
"email": "EMAIL", // email подписчика
"email_b64": "BASE64 EMAIL", // email закодированный в base64
"phone": PHONE, // номер телефона подписчика
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный индентификатор запуска цепочки.
"execution_date": "2020-04-09 11:17:44" // время выполнения
}
],
"total": 1 // сколько всего выполнений
}
Получить статистику блока "Цель"
Чтобы получить группированную статистику по блоку "Цель", отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/goal/sms/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // идентификатор блока
"executed": 2, // сколько всего выполнений блока
"sent": 2, // сколько всего отправлено
"delivered": 2, // сколько доставлнео
"opened": null, // сколько открыто
"clicked": null, // сколько переходов
"errors": 0, // сколько ошибок
"last_send": "2020-04-09 11:17:44" // дата последний отправки
}
}
Чтобы получить группированную статистику по блоку "Цель" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/goal/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": {
"executed": "4", // Кол-во выполнений блока "Цель"
"last_send": "2020-10-06 13:38:56" // Дата последней отправки
}
}
Чтобы получить список подписчиков, кому отправились смс сообщения, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortDirection | параметр сортировки, asc - от большего к меньшему, desc - от меньшего к большему |
sortField | параметр сортировки по полю дата выполнения блока |
Пример ответа:
{
"data": [
{
"email": "EMAIL", // email подписчика
"email_b64": "BASE64 EMAIL", // email закодированный в base64
"phone": PHONE, // номер телефона подписчика
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный индентификатор запуска цепочки.
"execution_date": "2020-04-09 11:17:44" // время выполнения
}
],
"total": 1 // сколько всего выполнений
}
Получить статистику блока "Действие"
Чтобы получить группированную статистику по блоку "Действие", отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/action/{ID}/group-stat |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
Пример ответа:
{
"data": {
"flow_id": {ID}, // идентификатор блока
"executed": 2, // к-во выполнений блока
"last_send": "2020-04-09 11:17:44" // время последнего выполнения
}
}
Чтобы получить группированную статистику по блоку "Действие" за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/action/{ID}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": {
"executed": "5", //Кол-во выполнений блока действие.
"last_send": "2020-10-18 12:36:38" // Дата последней отправки
}
}
Чтобы получить список подписчиков, для кого выполнилось действие, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/stats/flow-operator/{ID}/addresses?limit=10&offset=0&sortDirection=desc&sortField=execution_date |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
sortDirection | параметр сортировки, asc - от большего к меньшему, desc - от меньшего к большему |
sortField | параметр сортировки по полю дата выполнения блока |
Пример ответа:
{
"data": [
{
"email": "EMAIL", // email подписчика
"email_b64": "BASE64 EMAIL", // email закодированный в base64
"phone": PHONE, // номер телефона подписчика
"event_id": "dcf8e501483f4582fdb76a1831a74477", // уникальный индентификатор запуска цепочки.
"execution_date": "2020-04-09 11:17:44" // время выполнения
}
],
"total": 1 // сколько всего выполнений
}
Получить список конверсий авторассылки
Конверсии бывают двух типов:
- остановка серии по событию и включение опции засчитать в конверсию в стартовом блоке цепочки -
maintrigger
- попадание блока в цель -
goal
Чтобы получить информацию о количестве выполненных конверсий, а также количеству конверсий по каждому типу в цепочке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{id}/conversions |
Параметры запроса в URL:
ID | идентификатор авторассылки |
Пример ответа:
{
"data": {
"total_conversions": 5, // количество всего конверсий в авторассылке
"maintrigger_conversions": 1, // количество конверсий в стартовом блоке
"goal_conversions": 4, // количество конверсий в блоках "цель"
"maintrigger": { // информация про стартовый блок
"id": 233500,
"main_id": 127820,
"af_type": "maintrigger",
"created": "2020-04-28 18:00:09",
"last_send": "2020-04-28 18:13:44",
"conversions": 1
},
"goals": [ // информация про каждый блок "цель"
{
"id": 233502,
"name": "left",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 3
},
{
"id": 233503,
"name": "right",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 1
}
]
}
}
Примечание: значение параметра total_conversions
должно равнятся суме по параметрам maintrigger_conversions
и goal_conversions;
а также суме по параметрам maintrigger_conversions и goals
.
Чтобы получить информацию о количестве выполненных конверсий за выбранный период, а также количество конверсий по каждому типу в цепочке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{id}/conversions |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": {
"total_conversions": 5, // количество всего конверсий в авторассылке
"maintrigger_conversions": 1, // количество конверсий в стартовом блоке
"goal_conversions": 4, // количество конверсий в блоках "цель"
"maintrigger": { // информация про стартовый блок
"id": 233500,
"main_id": 127820,
"af_type": "maintrigger",
"created": "2020-04-28 18:00:09",
"last_send": "2020-04-28 18:13:44",
"conversions": 1
},
"goals": [ // информация про каждый блок "цель"
{
"id": 233502,
"name": "left",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 3
},
{
"id": 233503,
"name": "right",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 1
}
]
}
}
Получить список контактов попавших в конверсию
Чтобы получить список всех подписчиков попавших под любые из конверсий, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/all |
Чтобы получить список конверсий, которые создались через остановить серию по событию в стартовом блоке, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/maintrigger |
Чтобы получить список конверсий, которые создались через попадание подписчика в блоке цель, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal |
Чтобы получить список конверсий, которые создались через попадание в конкретный блок цель, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal{{goalID}} |
Параметры запроса в URL:
ID | идентификатор авторассылки |
goalID | идентификатор блока цели, можно узнать в методе выше |
Пример ответа:
{
"total": 5,
"items": [
{
"id": 40941,
"conversion_type": "maintrigger",
"flow_id": 233500,
"email": "m.jim@sendpulse.com",
"phone": null,
"conversion_date": "2020-04-28 18:13:53",
"start_date": "2020-04-28 18:13:44"
},
{
"id": 40940,
"conversion_type": "goal",
"flow_id": 233502,
"email": "m.jim@sendpulse.com",
"phone": null,
"conversion_date": "2020-04-28 18:03:44",
"start_date": "2020-04-28 18:03:42"
},
{
"id": 40939,
"conversion_type": "goal",
"flow_id": 233502,
"email": "m.jim@sendpulse.com",
"phone": null,
"conversion_date": "2020-04-28 18:02:52",
"start_date": "2020-04-28 18:02:50"
},
{
"id": 40938,
"conversion_type": "goal",
"flow_id": 233503,
"email": "m.jim@sendpulse.com",
"phone": null,
"conversion_date": "2020-04-28 18:02:43",
"start_date": "2020-04-28 18:02:40"
},
{
"id": 40937,
"conversion_type": "goal",
"flow_id": 233502,
"email": "m.jim@sendpulse.com",
"phone": null,
"conversion_date": "2020-04-28 18:01:59",
"start_date": "2020-04-28 18:01:56"
}
]
}
Чтобы получить список всех подписчиков попавших под любые из конверсий за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/all/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Чтобы получить список конверсий, которые создались через остановить серию по событию в стартовом блоке за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/maintrigger/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Чтобы получить список конверсий, которые создались через попадание подписчика в блоке цель за выбранный период
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goals/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Чтобы получить список конверсий, которые создались через попадание в конкретный блок цель за выбранный период, отправляется GET запрос по ссылке:
https://api.sendpulse.com/a360/autoresponders/{ID}/conversions/list/goal/{goalId}/group-stat-filtered?filter=JSON&limit=10&offset=0 |
Параметры запроса в URL:
ID | идентификатор блока в авторассылке, можно получить в первом методе |
goalId | идентификатор блока цели |
filter | кодированная JSON строка (URL encode) с параметрами даты (см. пример); вы можете добавлять один из параметров фильтра send_date_from и send_date_to или оба. |
limit | количество записей, максимум 100 |
offset | смещение выдачи (начиная с какой записи показывать), минимум 0 |
Пример ответа:
{
"data": {
"total_conversions": 5, // количество всего конверсий в авторассылке
"maintrigger_conversions": 1, // количество конверсий в стартовом блоке
"goal_conversions": 4, // количество конверсий в блоках "цель"
"maintrigger": { // информация про стартовый блок
"id": 233500,
"main_id": 127820,
"af_type": "maintrigger",
"created": "2020-04-28 18:00:09",
"last_send": "2020-04-28 18:13:44",
"conversions": 1
},
"goals": [ // информация про каждый блок "цель"
{
"id": 233502,
"name": "left",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 3
},
{
"id": 233503,
"name": "right",
"main_id": 127820,
"af_type": "goal",
"created": "2020-04-28 18:00:09",
"conversions": 1
}
]
}
}
Ошибки запроса
В случае ошибок валидации, неправильно составленного запроса к API возвращается 400 код ответа HTTP с информацией об ошибке.
Пример структуры ошибок:
{
"type": "validation_error",
"messages": {
"limit": [
"The limit field is required."
],
"offset": [
"The offset field is required."
]
}
}
Если данных по какому-то методу не найдено - вы получите 404 код ответа.
Регистрация через соцсети
Войти через Facebook Войти через Google