Get Segment

GET 
/segment/:id

Get all details of a segment

Request

Path Parameters

id uuidrequired

ID of the segment

Responses

200

successful operation

application/json

Schema

Schema

id uuid
name string
segmentType string

Possible values: [UPLOAD, INTEGRATION, CUSTOM, PREDEFINED_RECOMMENDED, PREDEFINED_LIBRARY]

numberOfCustomers number
sent number
bounced number
open number
clicked number
unsubscribed number
delivered number
spam number
openProgress number
clickedProgress number
unsubscribedProgress number
deliveredProgress number
bouncedProgress number
spamProgress number
filter object
condition object
type string
Possible values: [combined]
conditionType string
Possible values: [AND, OR]
conditions object[]
Array [
oneOf
BaseCondition
type string
attributeType string
attributeName string
criteria string
value object
type string
value number[]
]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "segmentType": "UPLOAD",
  "numberOfCustomers": 0,
  "sent": 0,
  "bounced": 0,
  "open": 0,
  "clicked": 0,
  "unsubscribed": 0,
  "delivered": 0,
  "spam": 0,
  "openProgress": 0,
  "clickedProgress": 0,
  "unsubscribedProgress": 0,
  "deliveredProgress": 0,
  "bouncedProgress": 0,
  "spamProgress": 0,
  "filter": {
    "condition": {
      "type": "combined",
      "conditionType": "AND",
      "conditions": [
        null,
        {}
      ]
    }
  }
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Loading...