API для данных об открытиях

Поиск данных об открытиях #

Открытия писем возвращает метод GET /messages/opens. Записи идут от новых к старым, каждое открытие — отдельная запись. По умолчанию возвращаются открытия за последний месяц; период задают параметры fromdate и todate.

Отбирать открытия можно по получателю (recipient), тегу (tag) и каналу (messagestream). Для постраничного чтения есть count (до 500) и offset.

В каждой записи — получатель, отправитель, тема, тег, MessageID и канал письма, время открытия, а также операционная система, браузер или почтовый веб-сервис, язык, регион и страна.

Нужен серверный API-ключ в заголовке X-Haskimail-Server-Token.

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

curl "https://api.haskimail.ru/messages/opens?count=50&offset=0&tag=orders" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"

Данные об открытиях для одного письма #

Открытия конкретного письма возвращает метод GET /messages/opens/{messageid}, где messageid — MessageID из ответа на отправку. Период для него не ограничен. Поля записей те же, что в общем списке.

Клики по ссылкам получают так же — методами GET /messages/clicks и GET /messages/clicks/{messageid}.

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

curl "https://api.haskimail.ru/messages/opens/6f1c0b2d9e8a4f7b3c5d2e1a0b9c8d7e?count=10&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Server-Token: server token"