Skip to main content

Get profile data in a static segment

Description

Get the data of profiles that are in a static segment, page by page.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
By default – json
idint1YesStatic segment ID
from_idstring"abcdefghijklmnqrstuvwxyz"NoID of the first profile to upload
from_dbint1Yes for from_idID of the database of the first profile
countint20NoNumber of records per page
fields[string]["custom_field_1"]NoList of fields to extract from the profile.
If empty — no fields are retrieved.

Request example

{    
"token": "abcdefghijklmnqrstuvwxyz",
"id": 13,
"from_id": "abcdefghijklmnqrstuvwxyz",
"from_db": 3,
"count": 25,
"fields": [email]
}

Response example

{
"next_id": 26,
"data": [ {
"profile_id": "abcdefghijklmnqrstuvwxyz",
"db_id": 3,
"xxh": "abcdefghijklmxyz",
"captured": "ISODateString",
"profile": {profile Object}
}
]}

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
next_idintNext profile in the request
dataJSON objectCustomer profile fields