Перейти к основному содержимому

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

Описание

Запрос для получения данных профилей статического сегмента постранично.

URL-адрес

Метод: POST

URL: https://example.com/api/v1.1/profiles/segstatic/list

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
(по умолчанию – "json")
idint1ДаИдентификатор статического сегмента
from_idstring"abcdefghijklmnqrstuvwxyz"НетИдентификатор первого профиля для выгрузки
from_dbint1Да для from_idИдентификатор Базы профилей первого профиля
countint20НетКоличество записей на странице
fields[]String["custom_field_1"]НетСписок полей для извлечения из профиля, если пусто — никакие поля не извлекаются

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

{    
"token": "abcdefghijklmnqrstuvwxyz",
"id": 33, // Идентификатор сегмента
"from_id": "abcdefghijklmnqrstuvwxyz", // С какого Id профиля начинать
"from_db": 75, // дополнение параметра from_id С какого Id профиля начинать, означающий базу данных
"count": 25, // Размер страницы
"fields": ["email"] // String, Список полей для извлечения из профиля, если пусто — никакие поля не извлекаются
}

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

{
"next_id": 26, //Если не пустое, значит есть еще id по запросу
"data": [ {
"profile_id": "abcdefghijklmnqrstuvwxyz",
"db_id": 3,
"xxh": "abcdefghijklmxyz",
"captured": "ISODateString",
"profile": {profile Object} // Если указаны поля для извлечения
}
]}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
next_idintСледующий профиль в запросе
dataJSON objectПоля профиля клиента