Получение данных по нескольким профилям

Описание

Получение данных по нескольким профилям.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
db_id	int	20	Да	Идентификатор базы данных
from_id	string	"0014a2feb331ace2.20200124134127"	Нет	Указатель на следующую страницу, берется из предыдущего запроса или передается пустой для первого.
limit	int	3	Нет	Лимит количества записей. По умолчанию - 1000.
query	JSON обект	"query": {    "$or":[       {          "_lname": "Black"       },       {          "_city": "Bay City"       }    ] }	Нет	Уточнение поиска профилей по параметрам в виде запроса к базе данных в формате JSON. Запрос формируется согласно документации к MongoDB.
fields	Array of string	"fields": [    "_id",    "_lname",    "_fname",    "_city",    "subscriptions" ],	Нет	Содержит поля для фильтрации отображаемых данных о профиле.

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

JSON

{
    "db_id": 1,
    "from_id": "65117f62736a0e15d273fae9",
    "limit": 1,
    "query": {
        "$or": [
            {
                "_lname": "Doe"
            },
            {
                "_city": "Moscow"
            }
        ]
    },
    "fields": [
        "_id",
        "_lname",
        "_fname",
        "_city",
        "subscriptions"
    ]
}

XML

<xml>
    <db_id>1</db_id>
    <from_id>65117f62736a0e15d273fae9</from_id>>
    <limit>1</limit>
    <fields>_id</fields>
    <fields>_lname</fields>
    <fields>_fname</fields>
    <fields>_city</fields>
    <fields>subscriptions</fields>
</xml>

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

JSON

{
    "data": [
        {
            "_city": "Moscow",
            "_fname": "Anna",
            "_lname": "Murphy",
            "id": "65117f62736a0e15d273faee",
            "subscriptions": [
                {
                    "resource_id": 5,
                    "channel": "email",
                    "email_data": {
                        "email": "example@example.edu",
                        "domain": "example.edu",
                        "domain_group": "other",
                        "md5": "7dbeb0466131e377e58988a97196d18e"
                    },
                    "priority": 0,
                    "status": "unsubscribed",
                    "reg_info": {
                        "date": "2024-01-09T12:12:18.172Z"
                    },
                    "hash_id": "e70dbabe",
                    "is_delete": false
                },
                {
                    "resource_id": 26,
                    "channel": "push",
                    "push_data": {
                        "subscription_id": "example@example.edu",
                        "provider": "Firefox"
                    },
                    "priority": 0,
                    "status": "subscribed",
                    "reg_info": {
                        "date": "2024-04-18T12:30:44.592Z"
                    },
                    "hash_id": "e70dbabe",
                    "is_delete": false
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": "65117f62736a0e15d273faf4"
}

XML

<xml>
    <data>
        <_city>Toronto</_city>
        <_fname>Juan</_fname>
        <_lname>Wallace</_lname>
        <id>65117f62736a0e15d273fae9</id>
        <subscriptions>
            <channel>email</channel>
            <email_data>
                <domain>@example.edu</domain>
                <domain_group>other</domain_group>
                <email>example@example.edu</email>
                <md5>18450b1edfef75279fc4f4f60c78d97e</md5>
            </email_data>
            <hash_id>a0cc2672</hash_id>
            <is_delete>false</is_delete>
            <priority>0</priority>
            <reg_info>
                <date>2024-01-09T12:12:18.172Z</date>
            </reg_info>
            <resource_id>5</resource_id>
            <status>hardbounced</status>
        </subscriptions>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <next_from_id>65117f62736a0e15d273faea</next_from_id>
</xml>

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

Основные поля

Параметр	Тип	Описание
error	int	Код ошибки. 0 — успешное выполнение
error_text	string	Текст ошибки
next_from_id	string	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории.
data	array of objects	Массив объектов профиля (см. Объект data)

Объект data

Каждый элемент массива data содержит информацию о профиле: контактные данные, геолокацию, данные о взаимодействиях с рассылками и другую информацию.

Параметр	Тип	Описание
id	string	Уникальный идентификатор профиля (MongoDB ObjectId)
db_id	int	Идентификатор базы данных
email	string	Email-адрес профиля
phones	array	Номера телефонов профиля
_status	int	Глобальный статус подписки
_is_test	bool	Флаг тестового профиля. Возвращает true, если профиль создан в тестовом режиме
gcg_is_exists	bool	Дубликат флага _flags.gcg_is_exists: профиль в данный момент находится в составе глобальной контрольной группы
_fname	string	Имя
_lname	string	Фамилия
_bdate	string	Дата рождения в формате RFC 3339
_sex	int	Пол (согласно списку гендерных идентификаций)
_avatar_set	bool	Показывает, установлен ли аватар профиля
_city	string	Город. Возвращается при наличии данных геолокации
_country	string	Страна в формате TLD. Возвращается при наличии данных геолокации
_region	string	Регион. Возвращается при наличии данных геолокации
_postal_code	string	Почтовый индекс. Возвращается при наличии данных геолокации
_lat	float	Географическая широта. Возвращается при наличии данных геолокации
_lon	float	Географическая долгота. Возвращается при наличии данных геолокации
_tz	string	Часовой пояс
_regdate	string	Дата регистрации профиля в формате RFC 3339
_createtime	string	Время создания профиля в формате RFC 3339
_subscribetime	string	Время подписки в формате RFC 3339
_updatetime	string	Время последнего обновления профиля в формате RFC 3339
_ip	string	IP-адрес. Возвращается при наличии данных трекинга
_browser	string	Браузер. Возвращается при наличии данных трекинга
_os	string	Операционная система. Возвращается при наличии данных трекинга
_platform	string	Платформа. Возвращается при наличии данных трекинга
_is_desktop	bool	Показывает, используется ли десктопное устройство. Возвращается при наличии данных трекинга
_is_mobile	bool	Показывает, используется ли мобильное устройство. Возвращается при наличии данных трекинга
_emaildomain	string	Домен email-адреса
_domaingroup	string	Группа домена
_acid	string	Уникальный идентификатор Altcraft
_md5	string	MD5-хэш email-адреса
_xxh	string	XXH-хэш идентификатор профиля
_xxm	int	XXH-хэш идентификатор профиля (числовое представление)
_send_exist	bool	Показывает, была ли отправка email
_send_date	string	Дата последней отправки email в формате RFC 3339. Возвращается при наличии отправки
_deliv_exist	bool	Показывает, была ли доставка email
_deliv_date	string	Дата последней доставки email в формате RFC 3339. Возвращается при наличии доставки
_open_exist	bool	Показывает, было ли открытие email
_open_date	string	Дата последнего открытия email в формате RFC 3339. Возвращается при наличии открытия
_read_exist	bool	Показывает, было ли прочтение email
_read_date	string	Дата последнего прочтения email в формате RFC 3339. Возвращается при наличии прочтения
_click_exist	bool	Показывает, был ли клик по ссылке в email
_click_date	string	Дата последнего клика по ссылке в email в формате RFC 3339. Возвращается при наличии клика
_confirm_exist	bool	Показывает, было ли подтверждение подписки
_confirm_date	string	Дата последнего подтверждения подписки в формате RFC 3339. Возвращается при наличии подтверждения
_reply_exist	bool	Показывает, был ли ответ на email
_reply_date	string	Дата последнего ответа на email в формате RFC 3339. Возвращается при наличии ответа
_sbounce_exist	bool	Показывает, был ли soft bounce (временный сбой доставки)
_sbounce_date	string	Дата последнего soft bounce в формате RFC 3339. Возвращается при наличии soft bounce
_undeliv_exist	bool	Показывает, была ли недоставка email
_undeliv_date	string	Дата последней недоставки email в формате RFC 3339. Возвращается при наличии недоставки
_pixel_open_exist	bool	Показывает, сработал ли пиксель отслеживания
_pixel_date	string	Дата последнего срабатывания пикселя в формате RFC 3339. Возвращается при наличии срабатывания
_send_sms_exist	bool	Показывает, была ли отправка SMS
_send_sms_date	string	Дата последней отправки SMS в формате RFC 3339. Возвращается при наличии отправки
_deliv_sms_exist	bool	Показывает, была ли доставка SMS
_deliv_sms_date	string	Дата последней доставки SMS в формате RFC 3339. Возвращается при наличии доставки
_click_sms_exist	bool	Показывает, был ли клик по ссылке в SMS
_click_sms_date	string	Дата последнего клика по ссылке в SMS в формате RFC 3339. Возвращается при наличии клика
_undeliv_sms_exist	bool	Показывает, была ли недоставка SMS
_undeliv_sms_date	string	Дата последней недоставки SMS в формате RFC 3339. Возвращается при наличии недоставки
_send_push_exist	bool	Показывает, была ли отправка push-уведомления
_send_push_date	string	Дата последней отправки push-уведомления в формате RFC 3339. Возвращается при наличии отправки
_open_push_exist	bool	Показывает, было ли открытие push-уведомления
_open_push_date	string	Дата последнего открытия push-уведомления в формате RFC 3339. Возвращается при наличии открытия
_read_push_exist	bool	Показывает, было ли прочтение push-уведомления
_read_push_date	string	Дата последнего прочтения push-уведомления в формате RFC 3339. Возвращается при наличии прочтения
_deliv_push_exist	bool	Показывает, была ли доставка push-уведомления
_deliv_push_date	string	Дата последней доставки push-уведомления в формате RFC 3339. Возвращается при наличии доставки
_click_push_exist	bool	Показывает, был ли клик по push-уведомлению
_click_push_date	string	Дата последнего клика по push-уведомлению в формате RFC 3339. Возвращается при наличии клика
_ps_wf	array	Идентификаторы маркетинговых сценариев, в которых участвовал профиль
_ps_wfs	array of objects	Детали участия в маркетинговых сценариях (см. Объект _ps_wfs)
_segs	array	Идентификаторы статических сегментов, в которых находится профиль
_flags	object	Флаги профиля (см. Объект _flags)
subscriptions	array of objects	Подписки профиля на ресурсы (см. Массив subscriptions)
unsub	object	Данные об отписке профиля (см. Объект unsub)

примечание

Помимо стандартных полей, в ответе могут присутствовать пользовательские поля базы данных. Их названия и типы зависят от структуры конкретной базы. Информацию о полях базы можно получить через /api/v1.1/databases/fields_get/.

примечание

Запрос поддерживает параметр fields для фильтрации возвращаемых полей. Если fields не указан, возвращаются все доступные поля профиля.

Массив subscriptions

Содержит подписки профиля на ресурсы. Один объект — одна подписка.

Параметр	Тип	Описание
resource_id	int	Идентификатор ресурса
channel	string	Тип канала (email, sms, push, whatsapp, viber, telegram_bot, notify)
email_data	object	Данные email-подписки. Возвращается для канала email
phone_data	object	Данные SMS-подписки. Возвращается для канала sms
priority	int	Приоритет подписки
status	string	Статус подписки
reg_info	object	Информация о регистрации подписки
hash_id	string	Хэш-идентификатор подписки
is_delete	bool	Показывает, удалена ли подписка

email_data — Данные email-подписки

Параметр	Тип	Описание
email	string	Email-адрес
domain	string	Домен email
domain_group	string	Группа домена
md5	string	MD5-хэш email

phone_data — Данные SMS-подписки

Параметр	Тип	Описание
phone	string	Номер телефона
md5	string	MD5-хэш телефона

reg_info — Информация о регистрации подписки

Параметр	Тип	Описание
date	string	Дата регистрации в формате RFC 3339

Объект unsub

Содержит данные об отписке профиля. Возвращается при наличии данных об отписке.

Параметр	Тип	Описание
c	int	Количество отписок
dt	string	Дата последней отписки в формате RFC 3339
m	int	Идентификатор рассылки, из которой была отписка

Объект _flags

Содержит флаги профиля: статусы участия в глобальной контрольной группе и флаги действий по каналам связи.

Параметр	Тип	Описание
channel_actions.email	object	Флаги действий по email-каналу (send, deliv, open, read, click, confirm, confirmsub, reply, unsub)
channel_actions.push	object	Флаги действий по push-каналу (send, deliv, open, click)
channel_actions.sms	object	Флаги действий по SMS-каналу (send, deliv, click, unsub)
gcg_is_exists	bool	Показывает, находится ли профиль в данный момент в составе глобальной контрольной группы
gcg_ca_is_exists	bool	Показывает, состоит ли профиль в аудитории глобальной контрольной группы
gcg_once_is_exists	bool	Показывает, был ли профиль когда-либо в составе глобальной контрольной группы
gcg_is_from_file	bool	Показывает, был ли профиль добавлен в глобальную контрольную группу способом «из файла»
scamp_once_exist	bool	Показывает, состоял ли профиль хотя бы раз в аудитории кампании
web_actions.pixel_open	bool	Показывает, сработал ли веб-пиксель

Объект _ps_wfs (элемент массива)

Содержит информацию об участии профиля в маркетинговых сценариях автоматизации.

Параметр	Тип	Описание
wId	int	Идентификатор сценария автоматизации
di	string	Дата входа профиля в сценарий в формате RFC 3339
do	string	Дата выхода профиля из сценария в формате RFC 3339. Возвращается при завершении участия
et	string	Причина выхода из сценария
ln	int	Номер последнего пройденного шага (узла) сценария
s	int	Статус участия профиля в сценарии