Description
Retrieves segments of a subscriber list.
Request Parameters
- APIKey = {string} (required)
- The API key you are using to authenticate the access.
- Command = {Segment.Get} (required)
- API Command
- ResponseFormat = {JSON | XML} (required)
- Response format
- JSONPCallBack = {bool}
- Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
- OrderField = {string} (required)
- Field name to order rows
- OrderType = {ASC | DESC} (required)
- Ascending or descending sorting
- SubscriberListID = {integer} (required)
- Subscriber list ID to return segments
Response Parameters
- Success = {true | false}
- States if there is an error or not
- ErrorCode = {integer}
- If there is an error, error's code
- ErrorText = {text}
- TotalSegments = {integer}
- Number of segments returned
- Segments = {array}
- Returned segment rows
Error Codes
- 1
- Missing subscriber list id
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
