Документация для версии v74
Получить историю нескольких профилей
Описание
Получить историю нескольких профилей.
URL-адрес
Метод: POST
https://example.com/api/v1.1/subscribers/history_get_all
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
| list_id | int | 20 | Да | Идентификатор базы данных |
| from_id | string | "0014a2feb331ace2.20200124134127" | Нет | Указатель на следующую страницу, берется из предыдущего запроса или передается пустой для первого. |
| limit | int | 500 | Нет | Лимит количества записей (по умолчанию – 1000) |
| date_from | string | "2016-11-25" | Да | Начало периода YYYY-MM-DD |
| date_to | string | "2016-11-29" | Да | Конец периода YYYY-MM-DD |
| fields | Array of string | ["CustomID"] | Нет | Добавит к результату поле fields с данными профиля из перечисленных полей. Для формата CSV будет представлен в виде JSON строки. |
Пример запроса
- JSON
- XML
{
"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"
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<list_id>1</list_id>
<limit>3</limit>
<date_from>2024-07-15</date_from>
<date_to>2024-10-09</date_to>
<format>xml</format>
<from_id>1</from_id>
<fields>CustomNumber</fields>
<fields>CustomEnum</fields>
</xml>
Пример ответа
- JSON
- XML
{
"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"
}
<xml>
<data>
<xxh>b8cdef2673dd18ff</xxh>
<profile_id>669e6966ebf4ac52b6239a9c</profile_id>
<email>heatherhawkins@tambee.name</email>
<list_id>6</list_id>
<action>subscribe_push</action>
<count>1</count>
<datetime>2024-07-22T14:15:02.838Z</datetime>
<message_id>0</message_id>
<campaign_id>0</campaign_id>
<event_id>669e6966ebf4ac52b6239aa4</event_id>
<smid></smid>
<campaign_name></campaign_name>
<message_name></message_name>
<subscription>
<resource_id>3</resource_id>
<resource_name>Push res</resource_name>
<channel>push</channel>
<subscription_id>2</subscription_id>
<provider>Chrome</provider>
<priority>0</priority>
<status>subscribed</status>
<custom_fields/>
<cats/>
</subscription>
<channel>push</channel>
<subscriptions>
<subscription>
<resource_id>3</resource_id>
<resource_name>Push res</resource_name>
<channel>push</channel>
<subscription_id>2</subscription_id>
<provider>Chrome</provider>
<priority>0</priority>
<status>subscribed</status>
<custom_fields/>
<cats/>
</subscription>
</subscriptions>
</item>
<item>
<xxh>2d15ffc902593f01</xxh>
<profile_id>669e6966ebf4ac52b6239a9e</profile_id>
<email>howardowens@jaxspan.org</email>
<list_id>6</list_id>
<action>subscribe_push</action>
<count>1</count>
<datetime>2024-07-22T14:15:02.839Z</datetime>
<message_id>0</message_id>
<campaign_id>0</campaign_id>
<event_id>669e6966ebf4ac52b6239aa5</event_id>
<smid></smid>
<campaign_name></campaign_name>
<message_name></message_name>
<subscription>
<resource_id>3</resource_id>
<resource_name>Push res</resource_name>
<channel>push</channel>
<subscription_id>0</subscription_id>
<provider>Chrome</provider>
<priority>0</priority>
<status>subscribed</status>
<custom_fields/>
<cats/>
</subscription>
<channel>push</channel>
<subscriptions>
<subscription>
<resource_id>3</resource_id>
<resource_name>Push res</resource_name>
<channel>push</channel>
<subscription_id>0</subscription_id>
<provider>Chrome</provider>
<priority>0</priority>
<status>subscribed</status>
<custom_fields/>
<cats/>
</subscription>
</subscriptions>
</item>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
<next_from_id>2</next_from_id>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| data | string | Массив полученных данных по событиям в истории профилей |
| data.xxh | string | xxhash идентификатор профиля |
| data.profile_id | string | Основной идентификатор профиля |
| data.email | string | Email-адрес профиля |
| data.list_id (db_id) | int | Идентификатор базы данных |
| data.action | string | Действие подписчика (Подробнее) |
| data.count | int | Количество действий, совершенных в эту секунду |
| data.datetime | string | Дата и время действия в формате RFC 3339 (ISO 8601) |
| data.message_id | int | Идентификатор шаблона сообщения Возвращает 0, если действие не предполагает использование шаблона. |
| data.campaign_id | int | Идентификатор рассылки Возвращает 0, если действие не предполагает использование рассылки. |
| data.event_id | string | Идентификатор события |
| data.smid | string | Уникальной идентификатор отправки в рамках рассылки Возвращает пустую строку, если действие не предполагает отправку сообщения. |
| data.campaign_name | string | Название рассылки Возвращает пустую строку, если действие не предполагает использование рассылки. |
| data.message_name | string | Название шаблона сообщения Возвращает пустую строку, если действие не предполагает использование шаблона. |
| data.subscription | string | Объект с информацией о подписке, в рамках которой выполнялась отправка |
| data.channel | string | Канал коммуникации, в рамках которого зарегистрировано событие. Возвращает пустую строку, если канал не задействован. |
| data.subscriptions | array of objects | Все подписки профиля. Для формата CSV будет представлены в виде JSON строки. |
| data.fields | object | Поля с данными профиля, запрошенные в поле fields. Для формата CSV будут представлены в виде JSON строки. |
| next_from_id | string | Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории. |
| error | int | Код ошибки |
| error_text | string | Текст ошибки |