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

Описание

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

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

{
    "date_from": "2020-01-24",
    "date_to": "2020-01-26",
    "format": "json",
    "from_id": "",
    "fields": ["CustomNumber", "CustomEnum"]
    "limit": 3,
    "list_id": 20,
    "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <date_from>2020-01-24</date_from>
  <date_to>2020-01-26</date_to>
  <format>json</format>
  <from_id>
  </from_id>
  <fields>CustomNumber</fields>
  1<fields>CustomEnum</fields>
  <limit>3</limit>
  <list_id>20</list_id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
  "data": [
    {
      "xxh": "0000183c20737b7e",
      "profile_id": "5c94fbc103e42237764042ef",
      "email": "mitzi.jpa2yj@example.com",
      "list_id": 1,
      "action": "web_version_save",
      "count": 1,
      "datetime": "2020-01-24T10:30:42Z",
      "message_id": 31,
      "campaign_id": 180,
      "subscriptions": [
        {
          "resource_id": 1,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed"
        },
        {
          "resource_id": 2,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed"
        }
      ],
      "fields": {
        "CustomEnum": 1,
        "CustomNumber": 1000000537
      }
    },
    {
      "xxh": "0000183c20737b7e",
      "profile_id": "5c94fbc103e42237764042ef",
      "email": "mitzi.jpa2yj@example.com",
      "list_id": 1,
      "action": "web_version_save",
      "count": 1,
      "datetime": "2020-01-24T10:41:27Z",
      "message_id": 31,
      "campaign_id": 183,
      "subscriptions": [
        {
          "resource_id": 1,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed"
        },
        {
          "resource_id": 2,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed"
        }
      ],
      "fields": {
        "CustomEnum": 1,
        "CustomNumber": 1000000537
      }
    },
    {
      "xxh": "0000183c20737b7e",
      "profile_id": "5c94fbc103e42237764042ef",
      "email": "mitzi.jpa2yj@example.com",
      "list_id": 1,
      "action": "send",
      "count": 1,
      "datetime": "2020-01-24T13:45:31Z",
      "message_id": 37,
      "campaign_id": 184,
      "subscriptions": [
        {
          "resource_id": 1,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed"
        },
        {
          "resource_id": 2,
          "channel": "email",
          "email": "mitzi.jpa2yj@example.com",
          "priority": 0,
          "status": "subscribed",
          "custom_fields": {
            "_browser_name": "Firefox",
            "_device_type": "web",
            "custom_field_1": "test value"
          },
          "cats": ["category_1", "category_2"]
        }
      ],
      "fields": {
        "CustomEnum": 1,
        "CustomNumber": 1000000537
      }
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "next_from_id": "0000183c20737b7e.20200124164531"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <xxh>0000183c20737b7e</xxh>
    <profile_id>5c94fbc103e42237764042ef</profile_id>
    <email>mitzi.jpa2yj@example.com</email>
    <list_id>1</list_id>
    <action>web_version_save</action>
    <count>1</count>
    <datetime>2020-01-24T10:30:42Z</datetime>
    <message_id>31</message_id>
    <campaign_id>180</campaign_id>
    <subscriptions>
      <resource_id>1</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
    </subscriptions>
    <subscriptions>
      <resource_id>2</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
    </subscriptions>
    <fields>
      <CustomEnum>1</CustomEnum>
      <CustomNumber>1000000537</CustomNumber>
    </fields>
  </data>
  <data>
    <xxh>0000183c20737b7e</xxh>
    <profile_id>5c94fbc103e42237764042ef</profile_id>
    <email>mitzi.jpa2yj@example.com</email>
    <list_id>1</list_id>
    <action>web_version_save</action>
    <count>1</count>
    <datetime>2020-01-24T10:41:27Z</datetime>
    <message_id>31</message_id>
    <campaign_id>183</campaign_id>
    <subscriptions>
      <resource_id>1</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
    </subscriptions>
    <subscriptions>
      <resource_id>2</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
    </subscriptions>
    <fields>
      <CustomEnum>1</CustomEnum>
      <CustomNumber>1000000537</CustomNumber>
    </fields>
  </data>
  <data>
    <xxh>0000183c20737b7e</xxh>
    <profile_id>5c94fbc103e42237764042ef</profile_id>
    <email>mitzi.jpa2yj@example.com</email>
    <list_id>1</list_id>
    <action>send</action>
    <count>1</count>
    <datetime>2020-01-24T13:45:31Z</datetime>
    <message_id>37</message_id>
    <campaign_id>184</campaign_id>
    <subscriptions>
      <resource_id>1</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
    </subscriptions>
    <subscriptions>
      <resource_id>2</resource_id>
      <channel>email</channel>
      <email>mitzi.jpa2yj@example.com</email>
      <priority>0</priority>
      <status>subscribed</status>
      <custom_fields browser_name='Firefox' device_type='web'>
        <custom_field_1>test value</custom_field_1>
      </custom_fields>
      <cats>category_1</cats>
      <cats>category_2</cats>
    </subscriptions>
    <fields>
      <CustomEnum>1</CustomEnum>
      <CustomNumber>1000000537</CustomNumber>
    </fields>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <next_from_id>0000183c20737b7e.20200124164531</next_from_id>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data.action	string	Действие подписчика (Подробнее)
data.count	int	Количество действий совершенных в эту секунду
data.datetime	string	Дата и время действия
data.email	string	Email адрес профиля
data.profile_id	string	Основной идентификатор профиля
data.subscriptions	Array of objects	Все подписки профиля. Для формата CSV будет представлены в виде JSON строки.
data.fields	Object	Дополнительные поля профиля, запрошенные в поле fields запроса. Для формата CSV будут представлены в виде JSON строки.
data.list_id (db_id)	int	Идентификатор базы данных
data.message_id	int	Идентификатор шаблона сообщения
data.xxh	string	xxhash идентификатор профиля
next_from_id	string	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории.