Segments

GET segments list
Returns the list of segments created in Engage UIX
Resource URL
https://api.commander1.com/api/dms/segmentation/segments/list
Resource Information
Response formats
JSON
Requires authentication?
Yes (token)
Parameters
NAME
REQUIREMENT
EXAMPLE VALUES
DESCRIPTION
site
d+
 1234
Id of the site to query detail for
token
[a-zA-Z0-9]*
 WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA
Security token
Example Request
GET
https://api.commander1.com/api/dms/segmentation/segments/list?site=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA
Example Result
[{"id":"BBFAC450","label":"VIP prospect"},{"id":"3DCC6A0A","label":"New customer"}]
GET segments IDs
Returns the list of segments for the user
Resource URL
https://api.commander1.com/api/dms/segmentation/segments
Resource Information
Response formats
javascript (JSONP)
Requires authentication?
No if tcid is not set, token if tcid is set
Parameters
NAME
REQUIREMENT
EXAMPLE VALUES
DESCRIPTION
site
\d+
 1234
Id of the site to query detail for
tcid (optional)
\d+
 1234
Id of the tcid (if cookie is disable)
token (optional)
[a-zA-Z0-9]*
 WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA
Security token (if tcid is set)
callback
\w+
 do_something
javascript callback method for JSONP
Example Request
GET
https://api.commander1.com/api/dms/segmentation/segments?site=1234&callback=tC_funcEngage
Example Result
/**/tC_funcEngage(["F92C4F26"]);

Last modified 3yr ago

NAME	REQUIREMENT	EXAMPLE VALUES	DESCRIPTION
site	d+	1234	Id of the site to query detail for
token	[a-zA-Z0-9]*	WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA	Security token

Response formats	javascript (JSONP)
Requires authentication?	No if tcid is not set, token if tcid is set