Description
API call to read custom 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 |
|---|---|---|---|
|
|
Number |
No |
The identifier for this group |
|
|
String |
No |
Custom segment group name |
|
|
String |
No |
The site group identifier to store the segment group under. In case of no group field specified all groups of this site group will be returned. |
Response
The response object for a successful query has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Object |
Array of segment group objects |
A segment group overview object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Number |
The identifier for this group |
|
|
String |
Segment group name |
|
|
String |
The site group identifier to which this segment group belongs |
|
|
String |
The creation time. Only available for customer admin and for admin ( |
|
|
String |
User name of person who created custom segment group. Only available for customer admin and for admin ( |
|
|
String |
The last changing time. Only available for customer admin and for admin ( |
|
|
String |
User name of last person who modified custom segment group. Only available for customer admin and for admin ( |
Examples
$ python cx.py /segment/group/read '{"siteGroupId":"10501"}'
{
"groups": [
{
"id":"123",
"group":"new group name",
"siteGroupId":"10501",
"createdBy": "user.user@mail.com",
"createdAt": "2022-08-16T05:12:45.982Z",
"lastChangedBy": "user.user@mail.com",
"lastChangedAt": "2022-08-16T05:12:45.982Z"
},
{
"id":"1234",
"group":"group name",
"siteGroupId":"10501",
"createdBy": "user.user@mail.com",
"createdAt": "2022-08-16T05:12:45.982Z",
"lastChangedBy": "user.user@mail.com",
"lastChangedAt": "2022-08-16T05:12:45.982Z"
}
]
}