Description
API call to read overview existing segment groups.
-
The user must be authenticated and have read permissions to the siteGroup.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
No |
The site group identifier to store the segment group under |
Response
The response object for a successful query has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Object |
Array of segment group overview objects |
A segment group overview object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Number |
The identifier for this group (only for the 'Custom' category) |
|
|
String |
Segment group name |
|
|
String |
Category the group has been assigned |
|
|
String |
The site group identifier to which this segment group belongs |
|
|
Number |
Number of segments in the segment group |
Examples
$ python cx.py /segment/group/overview '{"siteGroupId":"10501"}'
{
"groups": [
{
"id":"123",
"group":"location",
"category":"Custom",
"siteGroupId":"10501",
"numberOfSegments":"1"
},
{
"group":"Age",
"category":"Sociodemographic",
"siteGroupId":"10501",
"numberOfSegments":"2"
}
]
}