Get Segment Summary

PUT 
/segment/custom/summary

Get segment summary

Request

application/json

Body

required

customSegmentId uuid
audiences array
condition 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[]
values object[]
Array [
type string
value number[]
]
]

Responses

204

Successful operation

application/json

Schema

Schema

countCustomers int64
countNetCustomers int64
countDelivered int64
countCustomersHavingOpened int64
countCustomersHavingClicked int64
countCustomersHavingUnsubscribed int64
audiences object[]
Array [
criteria string
audiences object[]
Array [
id uuid
name string
segmentType string
Possible values: [UPLOAD, INTEGRATION, CUSTOM, PREDEFINED_RECOMMENDED, PREDEFINED_LIBRARY]
numberOfCustomers number
assignedToCampaigns boolean
description string
totalSubscribers number
assignedTo string
Possible values: [CAMPAIGN, FORM]
]
]

Example (from schema)

{
  "countCustomers": 10000,
  "countNetCustomers": 10000,
  "countDelivered": 10000,
  "countCustomersHavingOpened": 10000,
  "countCustomersHavingClicked": 10000,
  "countCustomersHavingUnsubscribed": 10000,
  "audiences": [
    {
      "criteria": "string",
      "audiences": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string",
          "segmentType": "UPLOAD",
          "numberOfCustomers": 10000,
          "assignedToCampaigns": true,
          "description": "string",
          "totalSubscribers": 0,
          "assignedTo": "CAMPAIGN"
        }
      ]
    }
  ]
}

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...