Version 5.0
AdvertServe User Manual :: v5.0

Segments :: Retrieve API Module

Retrieve

Description

Allows you to retrieve the properties of an existing segment.

Module URI

Hyperlink /servlet/control/api/segments/retrieve

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
idIntegerYes123 Must be the ID# of an existing segment

XML Response

Hyperlink /servlet/control/api/segments/retrieve?secret=(key)&id=123


<segment id="123" name="Acme Product Page" alias="LAIWVNIGAUOMB9DX" dmp="internal" timeout="30" pixel="123" status="true">
  <users total="100" daily="80"/>
  <notes/>
  <data>
    <![CDATA[{
      "key1": "value1",
      "key2": "value2"
    }]]>
  </data>
  <chained>
    <segment id="100"/>
  </chained>
  <negated>
    <segment id="101"/>
    <segment id="102"/>
    <segment id="103"/>
  </negated>
</segment>

JSON Response

Hyperlink /servlet/control/api/themes/retrieve?secret=(key)&output=json&id=123


{
  "id": 123,
  "name": "Acme Product Page",
  "alias": "LAIWVNIGAUOMB9DX",
  "dmp": "internal",
  "timeout": 30,
  "pixel": 123,
  "status": true,
  "users": {
    "total": 100,
    "daily": 80
  },
  "notes": "",
  "data": {
    "key1": "value1",
    "key2": "value2"
  },
  "chained": [
    100
  ],
  "negated": [
    101,
    102,
    103
  ]
}