Skip to main content
Version: 5.7.0

GetAllSegments

Gets the end-user segments for your app.

Segments are manually created on the brainCloud portal, on the Design | Segmentation | Segments page.

Results

NameDescription
segmentIdUnique id for the segmentId
nameReadable name of the segmentId
testersOnlyIf segement only applies to end-users flagged as testersOnly
descriptionReadable description of the segment
ServiceOperation
pushNotificationGET_ALL_SEGMENTS

Usage

http://localhost:3000
// S2S call: to view example, switch to the Cloud Code or Raw tab.
JSON Response
{
"packetId": 1,
"messageResponses": [
{
"data": {
"segments": [
{
"segmentId": 3,
"name": "New End-Users",
"testersOnly": false,
"description": "People that was started in the last 10 days."
},
{
"segmentId": 4,
"name": "Recurring End-Users",
"testersOnly": false,
"description": "People that have been active and have an account older than 10 days."
},
{
"segmentId": 5,
"name": "In-Active End-Users",
"testersOnly": false,
"description": "People that have been in-active and have an account older than 10 days."
}
]
},
"status": 200
}
]
}