Get data for multiple profiles

Description

Gets data for multiple profiles in the database.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
db_id	int	20	Yes	Database ID
from_id	string	"0014a2feb331ace2.20200124134127"	No	The pointer to the next page, taken from the previous request, or passed empty for the first one.
limit	int	3	No	Limit on the number of entries. Default - 1000
query	JSON обект	"query":{    "$or":[       {          "_lname": "Black"       },       {          "_city": "Bay City"       }    ] }	No	Refinement of the search for profiles by parameters in the form of a query to the database in JSON format. The request is formed according to the MongoDB documentation. To get a list of fields in the database, use the "Get database fields" request.
fields	Array of string	"fields": [    "_id",    "_lname",    "_fname",    "_city",    "subscriptions" ],	No	Contains fields for filtering the displayed profile data.

Request example

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>

Response example

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": "abcdefghijklmnqrstuvwxyz",
                        "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.com</domain>
                <domain_group>other</domain_group>
                <email>example@example.com</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>

Response parameters

Main fields

Parameter	Type	Description
error	int	Error code. 0 — successful operation
error_text	string	Error text
next_from_id	string	The value must be passed in the next request to get another piece of data until the result output contains 0 history lines.
data	array of objects	Array of profile objects (see data object)

data object

Each element of the data array contains information about the profile: contact data, geolocation, data on interactions with messages, and other information.

Parameter	Type	Description
id	string	Unique profile identifier (MongoDB ObjectId)
db_id	int	Database identifier
email	string	Profile email address
phones	array	Profile phone numbers
_status	int	Global subscription status
_is_test	bool	Test profile flag. Returns true if the profile was created in test mode
gcg_is_exists	bool	Duplicate of the _flags.gcg_is_exists flag: whether the profile is currently in the global control group
_fname	string	First name
_lname	string	Last name
_bdate	string	Birth date in RFC 3339 format
_sex	int	Gender (according to the gender identities list)
_avatar_set	bool	Indicates whether the profile avatar is set
_city	string	City. Returned when geolocation data is available
_country	string	Country in TLD format. Returned when geolocation data is available
_region	string	Region. Returned when geolocation data is available
_postal_code	string	Postal code. Returned when geolocation data is available
_lat	float	Geographic latitude. Returned when geolocation data is available
_lon	float	Geographic longitude. Returned when geolocation data is available
_tz	string	Time zone
_regdate	string	Profile registration date in RFC 3339 format
_createtime	string	Profile creation time in RFC 3339 format
_subscribetime	string	Subscription time in RFC 3339 format
_updatetime	string	Time of the last profile update in RFC 3339 format
_ip	string	IP address. Returned when tracking data is available
_browser	string	Browser. Returned when tracking data is available
_os	string	Operating system. Returned when tracking data is available
_platform	string	Platform. Returned when tracking data is available
_is_desktop	bool	Indicates whether a desktop device is used. Returned when tracking data is available
_is_mobile	bool	Indicates whether a mobile device is used. Returned when tracking data is available
_emaildomain	string	Email address domain
_domaingroup	string	Domain group
_acid	string	Unique Altcraft identifier
_md5	string	MD5 hash of the email address
_xxh	string	XXH hash profile identifier
_xxm	int	XXH hash profile identifier (numeric representation)
_send_exist	bool	Indicates whether an email was sent
_send_date	string	Date of the last email send in RFC 3339 format. Returned when a send exists
_deliv_exist	bool	Indicates whether an email was delivered
_deliv_date	string	Date of the last email delivery in RFC 3339 format. Returned when a delivery exists
_open_exist	bool	Indicates whether an email was opened
_open_date	string	Date of the last email open in RFC 3339 format. Returned when an open exists
_read_exist	bool	Indicates whether an email was read
_read_date	string	Date of the last email read in RFC 3339 format. Returned when a read exists
_click_exist	bool	Indicates whether a link in an email was clicked
_click_date	string	Date of the last link click in an email in RFC 3339 format. Returned when a click exists
_confirm_exist	bool	Indicates whether the subscription was confirmed
_confirm_date	string	Date of the last subscription confirmation in RFC 3339 format. Returned when a confirmation exists
_reply_exist	bool	Indicates whether an email was replied to
_reply_date	string	Date of the last email reply in RFC 3339 format. Returned when a reply exists
_sbounce_exist	bool	Indicates whether a soft bounce (temporary delivery failure) occurred
_sbounce_date	string	Date of the last soft bounce in RFC 3339 format. Returned when a soft bounce exists
_undeliv_exist	bool	Indicates whether an email was not delivered
_undeliv_date	string	Date of the last email non-delivery in RFC 3339 format. Returned when a non-delivery exists
_pixel_open_exist	bool	Indicates whether the tracking pixel fired
_pixel_date	string	Date of the last pixel firing in RFC 3339 format. Returned when a firing exists
_send_sms_exist	bool	Indicates whether an SMS was sent
_send_sms_date	string	Date of the last SMS send in RFC 3339 format. Returned when a send exists
_deliv_sms_exist	bool	Indicates whether an SMS was delivered
_deliv_sms_date	string	Date of the last SMS delivery in RFC 3339 format. Returned when a delivery exists
_click_sms_exist	bool	Indicates whether a link in an SMS was clicked
_click_sms_date	string	Date of the last link click in an SMS in RFC 3339 format. Returned when a click exists
_undeliv_sms_exist	bool	Indicates whether an SMS was not delivered
_undeliv_sms_date	string	Date of the last SMS non-delivery in RFC 3339 format. Returned when a non-delivery exists
_send_push_exist	bool	Indicates whether a push notification was sent
_send_push_date	string	Date of the last push notification send in RFC 3339 format. Returned when a send exists
_open_push_exist	bool	Indicates whether a push notification was opened
_open_push_date	string	Date of the last push notification open in RFC 3339 format. Returned when an open exists
_read_push_exist	bool	Indicates whether a push notification was read
_read_push_date	string	Date of the last push notification read in RFC 3339 format. Returned when a read exists
_deliv_push_exist	bool	Indicates whether a push notification was delivered
_deliv_push_date	string	Date of the last push notification delivery in RFC 3339 format. Returned when a delivery exists
_click_push_exist	bool	Indicates whether a push notification was clicked
_click_push_date	string	Date of the last push notification click in RFC 3339 format. Returned when a click exists
_ps_wf	array	Identifiers of marketing scenarios the profile participated in
_ps_wfs	array of objects	Details of participation in marketing scenarios (see the _ps_wfs object)
_segs	array	Identifiers of static segments the profile belongs to
_flags	object	Profile flags (see the _flags object)
subscriptions	array of objects	Profile subscriptions to resources (see the subscriptions array)
unsub	object	Profile unsubscription data (see the unsub object)

note

In addition to standard fields, custom database fields may be present in the response. Their names and types depend on the structure of the specific database. Information about database fields can be obtained via /api/v1.1/databases/fields_get/.

note

The request supports the fields parameter to filter returned fields. If fields is not specified, all available profile fields are returned.

subscriptions array

Contains profile subscriptions to resources. One object is one subscription.

Parameter	Type	Description
resource_id	int	Resource identifier
channel	string	Channel type (email, sms, push, whatsapp, viber, telegram_bot, notify)
email_data	object	Email subscription data. Returned for the email channel
phone_data	object	SMS subscription data. Returned for the sms channel
priority	int	Subscription priority
status	string	Subscription status
reg_info	object	Subscription registration information
hash_id	string	Hash identifier of the subscription
is_delete	bool	Indicates whether the subscription is deleted

email_data — Email subscription data

Parameter	Type	Description
email	string	Email address
domain	string	Email domain
domain_group	string	Domain group
md5	string	MD5 hash of the email

phone_data — SMS subscription data

Parameter	Type	Description
phone	string	Phone number
md5	string	MD5 hash of the phone number

reg_info — Subscription registration information

Parameter	Type	Description
date	string	Registration date in RFC 3339 format

unsub object

Contains profile unsubscription data. Returned when unsubscription data is available.

Parameter	Type	Description
c	int	Number of unsubscriptions
dt	string	Date of the last unsubscription in RFC 3339 format
m	int	Identifier of the campaign from which the unsubscription occurred

_flags object

Contains profile flags: global control group participation statuses and channel action flags.

Parameter	Type	Description
channel_actions.email	object	Email channel action flags (send, deliv, open, read, click, confirm, confirmsub, reply, unsub)
channel_actions.push	object	Push channel action flags (send, deliv, open, click)
channel_actions.sms	object	SMS channel action flags (send, deliv, click, unsub)
gcg_is_exists	bool	Indicates whether the profile is currently in the global control group
gcg_ca_is_exists	bool	Indicates whether the profile is in the global control group audience
gcg_once_is_exists	bool	Indicates whether the profile was ever in the global control group
gcg_is_from_file	bool	Indicates whether the profile was added to the global control group via "from file" method
scamp_once_exist	bool	Indicates whether the profile was in a campaign audience at least once
web_actions.pixel_open	bool	Indicates whether the web pixel fired

_ps_wfs object (array element)

Contains information about the profile's participation in marketing automation scenarios.

Parameter	Type	Description
wId	int	Marketing scenario identifier
di	string	Date the profile entered the scenario in RFC 3339 format
do	string	Date the profile exited the scenario in RFC 3339 format. Returned when participation is complete
et	string	Exit reason from the scenario
ln	int	Number of the last completed step (node) in the scenario
s	int	Profile participation status in the scenario