Jump to

• Request
• Response
• Examples

Retrieve Segment Groups

get

/rest/api/v1.3/lists/segmentGroups/records

Retrieves all Segment Groups for an Account

Request

Query Parameters

• limit(optional): integer
  limit
• offset(optional): integer
  offset

Back to Top

Response

Supported Media Types

• application/json

Default Response

A list of all Segment Groups with their metadata.

Body ()

Root Schema : Segment Group Array

Type: object

Title: Segment Group Array

Show Source

• segmentGroups: array segmentGroups

{
    "title":"Segment Group Array",
    "type":"object",
    "properties":{
        "segmentGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/segmentGroup"
            }
        }
    },
    "required":[
        "segmentGroups"
    ]
}

Nested Schema : segmentGroups

Type: array

Show Source

• Array of: object Segment Group
  Title: Segment Group

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/segmentGroup"
    }
}

Nested Schema : Segment Group

Type: object

Title: Segment Group

Show Source

• createdBy: string
  User who created the Segment Group
• createdDate: string(date)
  Segment Group creation date
• description: string
  Segment Group description
• folderName: string
  Folder containing the Segment Group
• listName: string
  Profile list name with which the Segment Group is associated
• modifiedBy: string
  User who modified the Segment Group
• modifiedDate: string(date)
  Segment Group modification date
• name: string
  Segment Group Name
• profileExtensionName: string
  Profile Extension name associated with the segment group. If no Profile Extension is associated, then it is set to null.

{
    "title":"Segment Group",
    "type":"object",
    "properties":{
        "name":{
            "description":"Segment Group Name",
            "type":"string"
        },
        "description":{
            "description":"Segment Group description",
            "type":"string"
        },
        "profileExtensionName":{
            "description":"Profile Extension name associated with the segment group. If no Profile Extension is associated, then it is set to null.",
            "type":"string"
        },
        "listName":{
            "description":"Profile list name with which the Segment Group is associated",
            "type":"string"
        },
        "folderName":{
            "description":"Folder containing the Segment Group",
            "type":"string"
        },
        "createdBy":{
            "description":"User who created the Segment Group",
            "type":"string"
        },
        "createdDate":{
            "description":"Segment Group creation date",
            "type":"string",
            "format":"date"
        },
        "modifiedBy":{
            "description":"User who modified the Segment Group",
            "type":"string"
        },
        "modifiedDate":{
            "description":"Segment Group modification date",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "name",
        "description",
        "profileExtensionName",
        "listName",
        "folderName",
        "createdBy",
        "createdDate",
        "modifiedBy",
        "modifiedDate"
    ]
}

Back to Top

Examples

Use this endpoint to retrieve all Segment Groups for an account.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Sample Request URL:

  /rest/api/v1.3/lists/segmentGroups/records?offset=5&limit=2
	

Sample Response: Success

{
  "segmentGroups": [
    {
      "name": "SegmentGroup1",
      "description": null,
      "profileExtensionName": null,
      "listName": "ProfileList1",
      "folderName": "Folder1",
      "createdBy": "api.user",
      "createdDate": 1604390400000,
      "modifiedBy": "api.user",
      "modifiedDate": 1604390400000
    },
    {
      "name": "SegmentGroup2",
      "description": null,
      "profileExtensionName": null,
      "listName": "ProfileList2",
      "folderName": "Folder2",
      "createdBy": "api.user",
      "createdDate": 1558249200000,
      "modifiedBy": "api.user",
      "modifiedDate": 1558249200000
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/lists/segmentGroups/records?offset=5&limit=2",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "/rest/api/v1.3/lists/segmentGroups/records?limit=2&offset=8",
      "method": "GET"
    },
    {
      "rel": "prev",
      "href": "/rest/api/v1.3/lists/segmentGroups/records?limit=2&offset=2",
      "method": "GET"
    }
  ]
}
	

Example Response:Failure

{
   "type": "",
   "title": "Segment not found",
   "errorCode": "SEGMENT_NOT_FOUND",
   "detail": "No segment group found in this account",
   "errorDetails": []
}
	

Back to Top