Segments :: Query API Module

Query

Description

Allows you to query for a list of segments using search criteria. A complete list of all existing segments will be returned if no search criteria is specified. Multiple search criteria may be specified together in the same query.

Module URI

/servlet/control/api/segments/query

Parameters

Parameter Name	Parameter Type	Required?	Example Value	Validation Rules (If Applicable)
secret	String	Yes	a78bf24c5a23581aceba1c5f51ac4cad	Must be a String containing no more than 32 characters
output	String	No	xml	Must be a String equal to either json or xml

Parameter Name	Parameter Type	Required?	Example Value	Validation Rules (If Applicable)
id	Integer	No	123	Must be the ID# of an existing segment
name	String	No	Acme Products Page	Must be a String containing no more than 80 characters
alias	String	No	HTDJFERCTRPQLUC2	Must be a String containing no more than 16 alphanumeric characters
timeout	Integer	No	90	Must be an Integer between 1 and 365
status	boolean	No	true	Must be a boolean value equal to either true or false
notes	String	No	N/A	Must be a String containing no more than 65,535 characters

Parameter Name	Parameter Type	Required?	Example Value	Validation Rules (If Applicable)
campaign	Integer	No	123	Must be the ID# of an existing campaign

XML Response

/servlet/control/api/segments/query?secret=(key)&name=acme


<results>
  <segment id="1" name="Acme Product Page" alias="LAIWVNIGAUOMB9DX" timeout="30" status="true">
    <notes/>
  </segment>
  <segment id="2" name="Acme Order Page" alias="AZFFZOKYDQQHZZQA" timeout="60" status="true">
    <notes/>
  </segment>
  <segment id="3" name="Acme Success Page" alias="HTDJFERCTRPQLUC2" timeout="90" status="true">
    <notes/>
  </segment>
</results>

JSON Response

/servlet/control/api/themes/query?secret=(key)&output=json&name=acme


{
  "results": [
    {
      "id": 1,
      "name": "Acme Product Page",
      "alias": "LAIWVNIGAUOMB9DX",
      "timeout": 30,
      "status": true,
      "notes": ""
    },
    {
      "id": 2,
      "name": "Acme Order Page",
      "alias": "AZFFZOKYDQQHZZQA",
      "timeout": 60,
      "status": true,
      "notes": ""
    },
    {
      "id": 3,
      "name": "Acme Success Page",
      "alias": "HTDJFERCTRPQLUC2",
      "timeout": 90,
      "status": true,
      "notes": ""
    }
  ]
}

< Previous Page

Segments API Module

Index

Next Page >

XXX