Перейти к содержанию

Емейлтрекинг

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/emailtracking/email/list?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/emailtracking/email/list?key=1234567890qwerty&project=12345
    

Получить список писем Емейлтрекинга

POST /project/emailtracking/email/list

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

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

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

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

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

{
    "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": {
                    "Тип лида": "Телефон",
                    "Дизайнер": "Артем Лебедев"
                }
            }
        }
    ],
    "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 нет
date string нет
email_from string нет
email_to string нет
subject string нет
body string нет
visit_id string нет
order_id string нет
visit object нет
>> id integer нет
>> first_id integer нет
>> date string нет
>> referrer string нет
>> host string нет
>> landing_page string нет
>> agent string нет
>> ip string нет
>> google_client_id string нет
>> source object нет
>>> system_name string нет
>>> display_name string нет
>>> icon_url string нет
>>> utm_source string нет
>>> utm_medium string нет
>>> utm_campaign string нет
>>> utm_term string нет
>>> utm_content string нет
>>> openstat null нет
>>> referrer string нет
order object нет
>> id integer нет
>> url string нет
>> source_type string нет
>> creation_date string нет
>> update_date string нет
>> revenue integer нет
>> cost integer нет
>> client_id integer нет
>> visit_id integer нет
>> page null нет
>> status object нет
>>> id integer нет
>>> type string нет
>>> name string нет
>> custom_fields object нет
>>> Тип лида string нет
>>> Дизайнер string нет
total integer нет
status string нет