Описание
Запрос для получения данных профилей статического сегмента постранично
URL-адрес
Метод: POST
URL: 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"] | Нет | Список полей для извлечения из профиля, |
Пример запроса
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 13, // Идентификатор сегмента
"from_id": "abcdefghijklmnqrstuvwxyz", // С какого Id профиля начинать
"from_db": 3, // дополнение параметра from_id С какого Id профиля начинать, означающий базу данных
"count": 25, // Размер страницы
"fields": [ ] String, // Список полей для извлечения из профиля, если пусто - никакие поля не извлекаются
}
Пример ответа
{
"next_id": 26, //Если не пустое, значит есть еще id по запросу
"data": [ {
"profile_id": "abcdefghijklmnqrstuvwxyz",
"db_id": 3,
"xxh": "abcdefghijklmxyz",
"captured": "ISODateString",
"profile": {profile Object} // Если указаны поля для извлечения
}
]}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| next_id | int | Следующий профиль в запросе |
| data | JSON object | Поля профиля клиента |