API Email-трекинга¶

Получить список писем Email-трекинга¶

POST https://cloud.roistat.com/api/v1/project/emailtracking/email/list

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Данный метод используется для получения списка писем Email-трекинга.

Если вместе с письмом вам нужна подробная информация по его визиту и сделке, то в теле запроса укажите "extend": ["visit","order"]. У объекта "visit" будет параметр metrika_client_id, по аналогии с google_client_id.

curl 'https://cloud.roistat.com/api/v1/project/emailtracking/email/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"filters": {"and": [["date",">","2019-01-01T21:00:00+0000"]]}}'

Тело запроса:

{
    "filters": {
        "and": [
            [
                "date",
                ">",
                "2019-01-01T21:00:00+0000"
            ],
            [
                "date",
                "<",
                "2019-02-01T21:00:00+0000"
            ]
        ]
    },
    "extend": [
        "visit",
        "order"
    ],
    "sort": [
        "date",
        "desc"
    ],
    "limit": 100,
    "offset": 0
}

{
    "data": [
        {
            "id": "12345",
            "date": "2016-06-19T09:31:01+0000",
            "email_from": "test@mail.com",
            "email_to": "test2@mail.com",
            "subject": "Тестовое письмо",
            "body": "текст письма",
            "visit_id": "12345",
            "order_id": "12345",
            "visit": {
                "id": 666,
                "first_id": 660,
                "date": "2016-05-25T19:31:58+0000",
                "referrer": "http://site.ru/contact.php",
                "host": "site.ru",
                "landing_page": "http://test.ru/lp",
                "agent": "Mozilla/5.0",
                "ip": "47.110.126.72",
                "google_client_id": "1818132860.1451606703",
                "source": {
                    "system_name": "direct_search_18000022_2014432344_что такое гугл адвордс",
                    "display_name": "Яндекс.Директ_Поиск_РК - adwords2 - поиск - Мир_Тратите деньги в Адвордс впустую?_что такое гугл адвордс",
                    "icon_url": "https://favicon.yandex.net/favicon/direct.yandex.ru",
                    "utm_source": "direct",
                    "utm_medium": "cpc",
                    "utm_campaign": "kampaniya",
                    "utm_term": "slovo",
                    "utm_content": "test-message",
                    "openstat": null,
                    "referrer": "http://site.ru/contact.php"
                }
            },
            "order": {
                "id": 777,
                "url": "http://site.ru/order/777",
                "source_type": "calltracking",
                "creation_date": "2016-05-22T19:32:22+0000",
                "update_date": "2016-05-22T19:32:22+0000",
                "revenue": 2000,
                "cost": 350,
                "client_id": 150,
                "visit_id": 666,
                "page": null,
                "status": {
                    "id": 31,
                    "type": "paid",
                    "name": "Оплачен"
                },
                "custom_fields": {
                    "Тип лида": "Телефон",
                    "Дизайнер": "Артем Лебедев"
                }
            },
             "attachment_ids": ["11","12","13","14","15","16"]
        }
    ],
    "total": 1,
    "status": "success"
}

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Параметр	Тип	Обязательный
filters	object	нет
> and	array[string]	нет
extend	array[string]	нет
sort	array[string]	нет
limit	integer	нет
offset	integer	нет

Параметр	Тип	Описание
data	array[object]
> id	string	ID письма
> date	string	Дата и время создания записи о письме (в формате UTC0)
> email_from	string	Адрес отправителя
> email_to	string	Адрес получателя
> subject	string	Тема письма
> body	string	Текст письма
> visit_id	string	Номер визита
> order_id	string	ID сделки
> visit	object	Подробные данные о визите. Будут отображены, только если при запросе было указано `"extend": ["visit"]`. В противном случае будет null.
>> id	integer	Текущий номер визита
>> first_id	integer	Номер первого визита в цепочке посещений клиента
>> date	string	Дата и время визита
>> referrer	string	Источник перехода
>> host	string	Домен
>> landing_page	string	Страница, на которую совершен визит
>> agent	string	Браузер посетителя
>> ip	string	IP посетителя
>> google_client_id	string	Значение ClientId, присвоенное счетчиком Google Analytics
>> source	object	Данные об источнике
>>> system_name	string	Системное название рекламного канала
>>> display_name	string	Человекочитаемое название рекламного канала
>>> icon_url	string	Ссылка на иконку канала
>>> utm_source	string	Значение метки utm_source у посетителя
>>> utm_medium	string	Значение метки utm_medium у посетителя
>>> utm_campaign	string	Значение метки utm_campaign у посетителя
>>> utm_term	string	Значение метки utm_term у посетителя
>>> utm_content	string	Значение метки utm_content у посетителя
>>> openstat	null	Значение метки openstat у посетителя
>>> referrer	string	Источник перехода
> order	object	Данные о сделке
>> id	integer	ID сделки
>> url	string	Внешний URL-адрес сделки из CRM
>> source_type	string	Тип источника: proxyform – заявка из формы, phone – Коллтрекинг, lead_hunter – Ловец лидов
>> creation_date	string	Дата и время создания сделки в формате UTC0
>> update_date	string	Дата и время последнего изменения данных о сделке в формате UTC0
>> revenue	integer	Выручка от сделки
>> cost	integer	Себестоимость сделки
>> client_id	integer	ID клиента
>> visit_id	integer	Номер визита
>> page	null	Страница визита
>> status	object	Информация о статусе сделки
>>> id	integer	ID статуса в системе Roistat
>>> type	string	Группа статусов, к которой относится текущий статус сделки: progress – В работе, paid – Оплаченные, canceled – Отмененные
>>> name	string	Человекочитаемое название статуса в CRM
>> custom_fields	object	Пользовательские поля
>>> Тип лида	string
>>> Дизайнер	string
> attachment_ids	array[integer]	ID вложенных файлов
total	integer	Количество результатов
status	string	Статус запроса

Скачать вложение из письма Email-трекинга¶

GET https://cloud.roistat.com/api/v1/project/emailtracking/email/{email_id}/attachment/{attachment_id}

ОписаниеПример запросаПример ответаПараметры запросаПараметры ответа

Данный метод используется для скачивания вложения из письма, полученного в Email-трекинге. Необходимо указать email_id для идентификации почтового сообщения и attachment_id для идентификации конкретного вложения.

Наименование файла передаётся в заголовках при скачивании с помощью параметра Content-Disposition, который содержит оригинальное наименование файла из письма.
Если включена настройка “Не отправлять вложения Email-трекинга в CRM и на webhook-адрес”, то вложения по API также не будут передаваться.

curl 'https://cloud.roistat.com/api/v1/project/emailtracking/email/1234/attachment/1235?project=12345' \
--request GET \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}'

Ответ не содержит параметров, но файл будет загружен в соответствии с Content-Disposition заголовком

Строка запроса:

Параметр	Тип	Описание	Обязательный
project	string	Номер проекта	да

Тело запроса:

Без параметров.