Общая статистика

С помощью API вы получить расширенную статистику отправки писем.

Отправьте GET запрос на URL http://api.mailhandler.ru/stat/reports/events-report/.

Запрос может содержать следующие параметры:

Название

Описание

Обязателен

Пример

date_from

Дата начала выборки в формате %d.%m.%Y

Нет

01.01.2017

date_to

Дата окончания выборки в формате %d.%m.%Y

Нет

31.01.2017

campaign_unique_id

Уникальный идентификатор рассылки

Нет

0f6fdbf5-b8d4-4694-b232-2a6879640942

event_types

Типы событий для выборки, по умолчанию - все. Вы можете одновременно передавать несколько типов событий, чтобы отфильтровать выборку по этим типам. Возможные типы: CREATED, SENT, OPENED, REDIRECTED, UNSUBSCRIBED, SOFTBOUNCED, HARDBOUNCED.

Нет

CREATED

Если вы не задаете временные рамки для выборки, отчет будет сформирован за прошлые 7 дней.

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

http://api.mailhandler.ru/stat/reports/events-report/?date_from=01.01.2017&date_to=31.01.2017&event_types=SENT&event_types=OPENED

В результате вы получите ответ в формате JSON с данными отчета.

Bash
Python
Bash

Пример получения списка объектов с помощью curl:

curl 'http://api.mailhandler.ru/stat/reports/events-report/' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Python

Пример получения списка объектов на python:

import requests
def report():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/stat/reports/events-report/',
json=data,
headers=headers)
print(response.status_code)

В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK

{
"results": {
"total": {
"redirected_percent": 0,
"opened": 10,
"opened_percent": "90.9",
"softbounced_percent": 0,
"unsubscribed_percent": 0,
"hardbounced_percent": 0,
"sent": 11
},
"data": [
{
"date": "01.01.2017",
"opened": 0,
"sent": 0
},
...
{
"date": "07.01.2017",
"opened": 0,
"sent": 0
}
]
}
}