Получить информацию о профиле

Описание

Получить информацию о профиле.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
db_id	int	1	Да	Идентификатор базы данных
Поиск профиля подписчика
matching	string	"email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика. По умолчанию - email.
email	string	"example@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название пользовательского поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение пользовательского поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Нет	Идентификатор ресурса для поиска по email и phone

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

JSON

{
    "db_id": 1,
    "email": "example@example.com"
}

XML

<xml>
    <db_id>1</db_id>
    <email>example@example.com</email>
</xml>

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

JSON

{
    "data": {
        "LOYALTY_SCORE": 500,
        "New_field_7": "00016",
        "_acid": "FBFLR5Z8BxgvNPxBJZgL",
        "_bdate": "1990-07-06T11:15:25.526Z",
        "_browser": "Chrome",
        "_city": "Beijing",
        "_click_exist": false,
        "_click_push_exist": false,
        "_click_sms_exist": false,
        "_confirm_exist": false,
        "_country": "CN",
        "_createtime": "2024-04-08T10:48:05.418Z",
        "_deliv_date": "2024-04-18T10:18:29.809Z",
        "_deliv_exist": true,
        "_deliv_push_exist": false,
        "_deliv_sms_date": "2024-05-06T10:00:05.548Z",
        "_deliv_sms_exist": true,
        "_domaingroup": "other",
        "_emaildomain": "example.com",
        "_fname": "Christopher",
        "_ip": "106.12.21.70",
        "_is_desktop": true,
        "_is_test": true,
        "_lat": 34.7732,
        "_lname": "Lambert",
        "_lon": 113.722,
        "_md5": "1118e73b34d3f9a9030b9e4da6dcfb29",
        "_open_date": "2024-04-18T10:18:29.727Z",
        "_open_exist": true,
        "_open_push_exist": false,
        "_os": "Windows 10",
        "_pixel_open_exist": false,
        "_platform": "Other",
        "_postal_code": "17",
        "_ps_wf": [
            12,
            11,
            10
        ],
        "_ps_wfs": [
            {
                "di": "2024-04-08T10:48:07.093Z",
                "do": "2024-04-13T10:48:22.359Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 12
            },
            {
                "di": "2024-04-08T19:35:04.15Z",
                "do": "2024-04-12T19:37:19.821Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 11
            },
            {
                "di": "2024-04-16T14:42:49.063Z",
                "do": "2024-04-17T14:42:52.438Z",
                "et": "",
                "ln": 8,
                "s": 1,
                "wId": 10
            }
        ],
        "_read_date": "2024-04-18T10:18:29.727Z",
        "_read_exist": true,
        "_regdate": "2024-04-08T10:48:05.418Z",
        "_region": "Beijing",
        "_reply_exist": false,
        "_send_date": "2024-04-10T09:32:06.275960407Z",
        "_send_exist": true,
        "_send_push_exist": false,
        "_send_sms_date": "2024-04-12T12:17:05.995339508Z",
        "_send_sms_exist": true,
        "_sex": 1,
        "_status": 0,
        "_subscribetime": "2024-04-08T10:48:05.418Z",
        "_tz": "Asia/Shanghai",
        "_undeliv_date": "2024-04-17T11:49:42.098Z",
        "_undeliv_exist": true,
        "_updatetime": "2024-04-19T14:25:22.185Z",
        "_xxh": "5ce324d8407a8e2b",
        "_xxm": 8507,
        "db_id": 1,
        "email": "example@example.com",
        "id": "6613cb65dc4594c2934db63f",
        "phones": [
            "+79568150396"
        ],
        "subscriptions": [
            {
                "resource_id": 24,
                "channel": "email",
                "email_data": {
                    "email": "example@example.com",
                    "domain": "example.com",
                    "domain_group": "other",
                    "md5": "1118e73b34d3f9a9030b9e4da6dcfb29"
                },
                "priority": 0,
                "status": "unsubscribed",
                "reg_info": {
                    "date": "2024-04-10T09:28:55.743Z"
                },
                "hash_id": "4a3c5813",
                "is_delete": false
            },
            {
                "resource_id": 25,
                "channel": "sms",
                "phone_data": {
                    "phone": "+79568150396",
                    "md5": "06ec7f059dae6f002d06a2f62a4320d8"
                },
                "priority": 0,
                "status": "subscribed",
                "reg_info": {
                    "date": "2024-04-12T12:16:44.086Z"
                },
                "hash_id": "f67a97c1",
                "is_delete": false
            }
        ],
        "unsub": {
            "c": 115,
            "dt": "2024-04-18T10:18:29.727Z",
            "m": 15
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <CRM_ID>66</CRM_ID>
        <LOYALTY_SCORE>500</LOYALTY_SCORE>
        <_acid>HWbGhUN1jKAdY8iNjdYf</_acid>
        <_browser>Chrome</_browser>
        <_city>St Petersburg</_city>
        <_click_exist>false</_click_exist>
        <_click_push_exist>false</_click_push_exist>
        <_click_sms_exist>false</_click_sms_exist>
        <_confirm_exist>false</_confirm_exist>
        <_country>RU</_country>
        <_createtime>2024-04-08T10:24:09.087Z</_createtime>
        <_deliv_date>2024-05-06T10:00:06.623Z</_deliv_date>
        <_deliv_exist>true</_deliv_exist>
        <_deliv_push_exist>false</_deliv_push_exist>
        <_deliv_sms_date>2024-05-06T10:00:05.274Z</_deliv_sms_date>
        <_deliv_sms_exist>true</_deliv_sms_exist>
        <_domaingroup>other</_domaingroup>
        <_emaildomain>example.com</_emaildomain>
        <_fname>Alina</_fname>
        <_ip>92.53.90.8</_ip>
        <_is_desktop>true</_is_desktop>
        <_is_mobile>true</_is_mobile>
        <_is_test>true</_is_test>
        <_lat>59.939095</_lat>
        <_lname>Lambert</_lname>
        <_lon>30.315868</_lon>
        <_md5>c5278382ce8972b4cd23b447c0e58989</_md5>
        <_open_date>2024-05-06T10:00:06.481Z</_open_date>
        <_open_exist>true</_open_exist>
        <_open_push_exist>false</_open_push_exist>
        <_os>Windows 10</_os>
        <_pixel_open_exist>false</_pixel_open_exist>
        <_platform>Other</_platform>
        <_postal_code>1042</_postal_code>
        <_ps_wf>12</_ps_wf>
        <_ps_wf>11</_ps_wf>
        <_ps_wfs>
            <di>2024-04-08T10:24:10.069Z</di>
            <do>2024-04-19T10:24:43.381Z</do>
            <et/>
            <ln>8</ln>
            <s>1</s>
            <wId>12</wId>
        </_ps_wfs>
        <_ps_wfs>
            <di>2024-04-08T19:35:04.091Z</di>
            <do>2024-04-18T19:37:37.428Z</do>
            <et/>
            <ln>8</ln>
            <s>1</s>
            <wId>11</wId>
        </_ps_wfs>
        <_read_date>2024-05-06T10:00:06.481Z</_read_date>
        <_read_exist>true</_read_exist>
        <_regdate>2024-04-08T10:24:09.087Z</_regdate>
        <_region>Saint Petersburg</_region>
        <_reply_exist>false</_reply_exist>
        <_sbounce_date>2024-04-28T10:00:03.452Z</_sbounce_date>
        <_sbounce_exist>true</_sbounce_exist>
        <_send_date>2024-04-10T09:32:05.531223661Z</_send_date>
        <_send_exist>true</_send_exist>
        <_send_push_exist>false</_send_push_exist>
        <_send_sms_date>2024-04-18T11:14:02.172438444Z</_send_sms_date>
        <_send_sms_exist>true</_send_sms_exist>
        <_status>0</_status>
        <_subscribetime>2024-04-08T10:24:09.087Z</_subscribetime>
        <_tz>Europe/Moscow</_tz>
        <_undeliv_date>2024-04-17T11:49:39.091Z</_undeliv_date>
        <_undeliv_exist>true</_undeliv_exist>
        <_undeliv_sms_date>2024-04-22T10:00:02.62Z</_undeliv_sms_date>
        <_undeliv_sms_exist>true</_undeliv_sms_exist>
        <_updatetime>2024-04-18T12:36:31.7Z</_updatetime>
        <_xxh>507a01069df7046e</_xxh>
        <_xxm>7902</_xxm>
        <db_id>1</db_id>
        <email>example@example.com</email>
        <id>6613c5c94a5d12bd6cc09171</id>
        <phones>+79006574081</phones>
        <subscriptions>
            <channel>email</channel>
            <email_data>
                <domain>example.com</domain>
                <domain_group>other</domain_group>
                <email>example@example.com</email>
                <md5>c5278382ce8972b4cd23b447c0e58989</md5>
            </email_data>
            <hash_id>fcc69fe5</hash_id>
            <is_delete>false</is_delete>
            <priority>0</priority>
            <reg_info>
                <date>2024-04-10T09:28:55.706Z</date>
            </reg_info>
            <resource_id>24</resource_id>
            <status>subscribed</status>
        </subscriptions>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

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

Параметр	Тип	Описание
error	int	Код ошибки. 0 — успешное выполнение
error_text	string	Текст ошибки
data	object	Информация о профиле

Объект 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/.

Массив 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	Статус участия профиля в сценарии