Перейти к основному содержимому
Документация для версии v73

Получить историю нескольких профилей

Описание​

Получить историю нескольких профилей.

URL-адрес​

Метод: POST

https://example.com/api/v1.1/subscribers/history_get_all

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
(по умолчанию – "json")
list_idint20ДаИдентификатор базы данных
from_idstring"0014a2feb331ace2.20200124134127"НетУказатель на следующую страницу, берется из предыдущего запроса или передается пустой для первого.
limitint500НетЛимит количества записей
(по умолчанию – 1000)
date_fromstring"2016-11-25"ДаНачало периода
YYYY-MM-DD
date_tostring"2016-11-29"ДаКонец периода
YYYY-MM-DD
fieldsArray of string["CustomID"]НетДобавит к результату поле fields с данными профиля из перечисленных полей. Для формата CSV будет представлен в виде JSON строки.

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

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "list_id": 4,
    "limit": 3,
    "date_from": "2024-07-15",
    "date_to": "2024-10-08",
    "format": "json",
    "from_id": "1",
    "fields": [
        "CustomNumber",
        "CustomEnum"
    ]
}

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

{
    "data": [
        {
            "xxh": "b8cdef2673dd18ff",
            "profile_id": "669e6966ebf4ac52b6239a9c",
            "email": "heatherhawkins@tambee.name",
            "list_id": 6,
            "action": "subscribe_push",
            "count": 1,
            "datetime": "2024-07-22T14:15:02.838Z",
            "message_id": 0,
            "campaign_id": 0,
            "event_id": "669e6966ebf4ac52b6239aa4",
            "smid": "",
            "campaign_name": "",
            "message_name": "",
            "subscription": {
                "resource_id": 3,
                "resource_name": "Push res",
                "channel": "push",
                "subscription_id": "2",
                "provider": "Chrome",
                "priority": 0,
                "status": "subscribed",
                "custom_fields": {},
                "cats": []
            },
            "channel": "push",
            "subscriptions": [
                {
                    "resource_id": 3,
                    "resource_name": "Push res",
                    "channel": "push",
                    "subscription_id": "2",
                    "provider": "Chrome",
                    "priority": 0,
                    "status": "subscribed",
                    "custom_fields": {},
                    "cats": []
                }
            ]
        },
        {
            "xxh": "2d15ffc902593f01",
            "profile_id": "669e6966ebf4ac52b6239a9e",
            "email": "howardowens@jaxspan.org",
            "list_id": 6,
            "action": "subscribe_push",
            "count": 1,
            "datetime": "2024-07-22T14:15:02.839Z",
            "message_id": 0,
            "campaign_id": 0,
            "event_id": "669e6966ebf4ac52b6239aa5",
            "smid": "",
            "campaign_name": "",
            "message_name": "",
            "subscription": {
                "resource_id": 3,
                "resource_name": "Push res",
                "channel": "push",
                "subscription_id": "0",
                "provider": "Chrome",
                "priority": 0,
                "status": "subscribed",
                "custom_fields": {},
                "cats": []
            },
            "channel": "push",
            "subscriptions": [
                {
                    "resource_id": 3,
                    "resource_name": "Push res",
                    "channel": "push",
                    "subscription_id": "0",
                    "provider": "Chrome",
                    "priority": 0,
                    "status": "subscribed",
                    "custom_fields": {},
                    "cats": []
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": "2"
}

Возвращаемые параметры​

ПараметрТипОписание
datastringМассив полученных данных по событиям в истории профилей
data.xxhstringxxhash идентификатор профиля
data.profile_idstringОсновной идентификатор профиля
data.emailstringEmail-адрес профиля
data.list_id (db_id)intИдентификатор базы данных
data.actionstringДействие подписчика (Подробнее)
data.countintКоличество действий, совершенных в эту секунду
data.datetimestringДата и время действия в формате RFC 3339 (ISO 8601)
data.message_idintИдентификатор шаблона сообщения

Возвращает 0, если действие не предполагает использование шаблона.
data.campaign_idintИдентификатор кампании

Возвращает 0, если действие не предполагает использование кампании.
data.event_idstringИдентификатор события
data.smidstringУникальной идентификатор отправки в рамках кампании

Возвращает пустую строку, если действие не предполагает отправку сообщения.
data.campaign_namestringНазвание кампании

Возвращает пустую строку, если действие не предполагает использование кампании.
data.message_namestringНазвание шаблона сообщения

Возвращает пустую строку, если действие не предполагает использование шаблона.
data.subscriptionstringОбъект с информацией о подписке, в рамках которой выполнялась отправка
data.channelstringКанал коммуникации, в рамках которого зарегистрировано событие.

Возвращает пустую строку, если канал не задействован.
data.subscriptionsarray of objectsВсе подписки профиля. Для формата CSV будет представлены в виде JSON строки.
data.fieldsobjectПоля с данными профиля, запрошенные в поле fields. Для формата CSV будут представлены в виде JSON строки.
next_from_idstringУказатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории.
errorintКод ошибки
error_textstringТекст ошибки
Последнее обновление