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

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
id	int	1	Yes	Static segment ID
from_id	string	"abcdefghijklmnqrstuvwxyz"	No	ID of the first profile to upload
from_db	int	1	Yes for from_id	ID of the database of the first profile
count	int	20	No	Number of records per page
fields	[]String	["custom_field_1"]	No	List of fields to extract from the profile. If empty — no fields are retrieved.

Request example

JSON

{   
   "token": "abcdefghijklmnqrstuvwxyz",
   "id": 13, // Segment ID
   "from_id": "abcdefghijklmnqrstuvwxyz",
   "from_db": 3, 
   "count": 25,
   "fields": [ ] String
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>33</id>
    <from_id>abcdefghijklmnqrstuvwxyz</from_id>
    <from_db>75</from_db>
    <count>25</count>
    <fields>email</fields>
    <fields>_country</fields>
</xml>

Response example

JSON

{
  "next_id": 26, // If not empty, then there is another id on request
  "data": [  
    {
      "profile_id": "abcdefghijklmnqrstuvwxyz",
      "db_id": 3,
      "xxh": "abcdefghijklmxyz",
      "captured": "ISODateString",
      "profile": {profile Object} // If fields to extract are specified
    }
  ]
}

XML

<result>
  <next_id>26</next_id>
  <data>
    <profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
    <db_id>3</db_id>
    <xxh>abcdefghijklmxyz</xxh>
    <captured>ISODateString</captured>
    <profile></profile>
  </data>
</result>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
next_id	int	Next profile in the request
data	JSON object	Customer profile fields