Get segment information

Description

Retrieves a segment detailed information.

Request URL

Method: POST

https://example.com/api/v1.1/segments/get/

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	No	Segment ID

Request example

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "data": {
        "count": 100,
        "id": 1,
        "name": "Segment A",
        "segment": [
            {
                "condition": "or",
                "limit": 0,
                "list_id": 1,
                "percent_from": 0,
                "percent_to": 99,
                "queries": [
                    {
                        "child": [],
                        "compo": "domaingroup",
                        "condition": "",
                        "name": "email",
                        "operator": "equal",
                        "type": "email",
                        "value": [
                            {
                                "name": "domaingroup",
                                "value": "Yahoo! (US)"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "error": 0,
    "error_text": "Successful operation"
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
count	int	Profiles in the segment
id	int	Segment ID
name	string	Segment name
segment	JSON array	segment details