Получить данные профилей статического сегмента
Описание
Запрос для получения данных профилей статического сегмента постранично.
URL-адрес
Метод: POST
https://example.com/api/v1.1/profiles/segstatic/list
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
id | int | 1 | Да | Идентификатор статического сегмента |
from_id | string | "abcdefghijklmnqrstuvwxyz" | Нет | Идентификатор первого профиля для выгрузки |
from_db | int | 1 | Да для from_id | Идентификатор Базы профилей первого профиля |
count | int | 20 | Нет | Количество записей на странице |
fields | [string] | ["custom_field_1"] | Нет | Список полей для извлечения из профиля, если пусто — никакие поля не извлекаются |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 13,
"from_id": "abcdefghijklmnqrstuvwxyz",
"from_db": 3,
"count": 25,
"fields": ["email"]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>33</id>
<from_id>abcdefghijklmnqrstuvwxyz</from_id>
<from_db>75</from_db>
<count>25</count>
<fields array="true">email</fields>
</xml>
Пример ответа
- JSON
- XML
{
"next_id": 26,
"data": [ {
"profile_id": "abcdefghijklmnqrstuvwxyz",
"db_id": 3,
"xxh": "abcdefghijklmxyz",
"captured": "ISODateString",
"profile": {profile Object}
}
]}
<xml>
<next_id>26</next_id>
<data>
<profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
<db_id>3</db_id>
<xxh>abcdefghijklmxyz</xxh>
<captured>ISODateString</captured>
<profile></profile>
</data>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
next_id | int | Следующий профиль в запросе |
data | JSON object | Поля профиля клиента |