Аккаунт
Выйти

Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

API Статистики

Позволяет получить всю статистику по вашим исходящим письмам для конкретного сервера. Эта статистика хранится постоянно и не имеет срока действия. Все статистические данные используют часовой пояс МСК (GMT+3). Если даты from/to не указаны, возвращается статистика за все время.

Обзор статистики по исходящим письмам #

get

/stats

Получает краткий обзор статистики по всем вашим исходящим письмам.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API».

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

curl "https://api.haskimail.ru/stats?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Sent integer

Количество отправленных писем.
Bounced integer

Количество возвратов.
BounceRate double

Уровень возвратов в процентах, рассчитанный от общего числа отправленных.
SpamComplaints integer

Количество жалоб на спам.
SpamComplaintsRate double

Уровень жалоб на спам в процентах, рассчитанный от общего числа отправленных.
Opened integer

Количество открытий.
OpenRate double

Уровень открытий в процентах, рассчитанный от общего числа отправленных.
Clicked integer

Общее количество кликов по всем отслеживаемым ссылкам.
ClickRate double

Уровень кликов в процентах, рассчитанный от общего числа отправленных.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Sent": 615,
  "Bounced": 64,
  "BounceRate": 10.40,
  "SpamComplaints": 10,
  "SpamComplaintsRate": 1.62,
  "Opened": 166,
  "Clicked": 72,
  "OpenRate": 12.50,
  "ClickRate": 7.82
}

Статистика по отправленным #

get

/stats/sends

Получает общее количество отправленных вами писем.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail.

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

curl "https://api.haskimail.ru/stats/sends?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Дни, за которые нет статистики, не будут отображаться в JSON-ответе.

Days array

Список объектов, каждый из которых представляет количество отправленных писем по дате.
Sent integer

Количество отправленных писем.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Days": [
    {
      "Date": "2014-01-01",
      "Sent": 140
    },
    {
      "Date": "2014-01-02",
      "Sent": 160
    },
    {
      "Date": "2014-01-04",
      "Sent": 50
    },
    {
      "Date": "2014-01-05",
      "Sent": 115
    }
  ]
}

Статистика по возвратам #

get

/stats/bounces

Получает общее количество отправленных вами писем, которые были возвращены.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail.

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

curl "https://api.haskimail.ru/stats/bounces?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Дни, за которые нет статистики, не будут отображаться в JSON-ответе.

Days array

Список объектов, каждый из которых представляет количество возвратов по дате.
HardBounce integer

Указывает общее количество жестких возвратов.
SoftBounce integer

Указывает общее количество мягких возвратов.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Days": [
    {
      "Date": "2014-01-01",
      "HardBounce": 12,
      "SoftBounce": 36
    },
    {
      "Date": "2014-01-03",
      "HardBounce": 7
    },
    {
      "Date": "2014-01-04",
      "HardBounce": 4
    },
    {
      "Date": "2014-01-05",
      "HardBounce": 25,
      "SoftBounce": 5
    }
  ]
}

Статистика по жалобам на спам #

get

/stats/spam

Получает общее количество получателей, которые отметили ваше письмо как спам.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail.

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

curl "https://api.haskimail.ru/stats/spam?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Дни, за которые нет статистики, не будут отображаться в JSON-ответе.

Days array

Список объектов, каждый из которых представляет количество жалоб на спам по дате.
SpamComplaint integer

Количество жалоб на спам.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Days": [
    {
      "Date": "2014-01-01",
      "SpamComplaint": 2
    },
    {
      "Date": "2014-01-02",
      "SpamComplaint": 3
    },
    {
      "Date": "2014-01-05",
      "SpamComplaint": 5
    }
  ]
}

Статистика по открытиям #

get

/stats/opens

Получает общее количество получателей, которые открыли ваши письма. Эта информация записывается, только если для письма включено отслеживание открытий.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail.

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

curl "https://api.haskimail.ru/stats/opens?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Дни, за которые нет статистики, не будут отображаться в JSON-ответе.

Days array

Список объектов, каждый из которых представляет количество отслеживаемых писем по дате.
Opens integer

Указывает общее количество открытых писем. Это число включает получателей, которые открывали ваше письмо несколько раз.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Days": [
    {
      "Date": "2014-01-01",
      "Opens": 44,
    },
    {
      "Date": "2014-01-02",
      "Opens": 46,
    },
    {
      "Date": "2014-01-03",
      "Opens": 25,
    },
    {
      "Date": "2014-01-04",
      "Opens": 25,
    },
    {
      "Date": "2014-01-05",
      "Opens": 26,
    }
  ]
}

Статистика по кликам #

get

/stats/clicks

Получает общее количество уникальных ссылок, по которым были совершены переходы.

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Server-Token обязательный

Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail.

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

curl "https://api.haskimail.ru/stats/clicks?fromdate=2014-01-01&todate=2014-02-01" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

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

tag

Фильтровать по тегу.
fromdate

Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01.
todate

Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01.
messagestream

Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере.

Ответ

Дни, за которые нет статистики, не будут отображаться в JSON-ответе.

Days array

Список объектов, каждый из которых представляет количество кликов по дате.
Clicks integer

Указывает общее количество кликов по ссылкам. Это число включает получателей, которые кликали по ссылкам в вашем письме несколько раз.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Days": [
    {
      "Date": "2014-01-01",
      "Clicks": 44,
    },
    {
      "Date": "2014-01-02",
      "Clicks": 46,
    },
    {
      "Date": "2014-01-03",
      "Clicks": 25,
    },
    {
      "Date": "2014-01-04",
      "Clicks": 25,
    },
    {
      "Date": "2014-01-05",
      "Clicks": 26,
    }
  ]
}