Returns owner_ID, segment_ID and related information for all segments, including number of current contacts in segment as of the time of the call.
JSON Request Example:
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Segments |
requestmethod | GetSegments |
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if lists found for the user name supplied |
"response"
"data"
"item" element - One will be returned for each segment
Field Name | Description |
ownerid | Account owner ID |
segmentid | Segment ID |
segmentname | Segment name |
createdate | The create date timestamp |
contacts | Number of contacts in segment at time of API call |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED when unsuccessful |
errormessage | Text explaining why request failed |