/site/group | Documentation

Retrieves information about one or more site groups.

The user must be authenticated and have read permissions to the given site group.

Request

The request object has the following fields:

Name	Type	Required	Description
`siteGroupId`	String	No	The identifier of the site group to retrieve. Can not be combined with `siteGroupIds`.
`siteGroupIds`	Array of String	No	An array of identifiers for site groups to retrieve. Can not be combined with `siteGroupId`.
`composerApplicationId`	String	No	A composerApplicationId assigned to the customer
`prefix`	String	No	A prefix associated with the customer

If no parameters are specified, all site groups the user has read permissions to are retrieved.

Response

The response object has the following fields:

Name	Type	Description
`siteGroups`	Array of Object	Array of site group objects.

A site group object has the following fields:

Name	Type	Description
`id`	String	Site group identifier.
`name`	String	Site group name. (max 32 characters)
`description`	String	Site group description.
`siteIds`	Array of String	Array of site identifiers that are directly linked to this site group.
`permissions`	Array of Object	Array of permission objects specifying the users that have access to the site group and their permission. Note: This will only contain the current user except for customer admin.
`parentSiteGroupIds`	List of Strings	List of parent site groups for which the user has read permissions.
`composerApplicationId`	String	The Piano application identifier (aid), given that the site group is connected to an application in the Piano product suite. This field is only visible to customer admin. Updates can only be made be a Piano admin
`minAudienceSize`	Integer	Minimum audience size. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`durationForMinAudienceSize`	Integer	Duration for minAudienceSize. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`segmentAutoDeletionEnabled`	Boolean	Enables segment auto deletion by `minAudienceSize` and `durationForMinAudienceSize`. Only available for customer admin (`?customerAdmin=true`)
`updateRelatedSegments`	Boolean	Activating this option leads to updating and/or deleting related segments in case of automatic deletion of the main segments of the site group. Only available for customer admin (`?customerAdmin=true`)
`createdAt`	String	The creation time. Only available for customer admin (`?customerAdmin=true`)
`createdBy`	String	User name of person who created user. Only available for customer admin (`?customerAdmin=true`)
`lastChangedAt`	String	The last changing time. Only available for customer admin (`?customerAdmin=true`)
`lastUpdatedBy`	String	User name of last person who modified user. Only available for customer admin (`?customerAdmin=true`)

A permission object has the following fields:

Name	Type	Description
`username`	String	User identifier for the user with permission to the site group.
`read`	Boolean	True if the user has read permission to the site group.
write	Boolean	True if the user has write permission to the site group.

Examples

Bash

$ python cx.py /site/group '{"siteGroupId":"9222300742653756873"}'
{
 "siteGroups": [
 {
 "id": "9222300742653756873",
 "name": "Example",
 "description": "Example site group",
 "siteIds": [
 "9222300742735526873"
 ],
 "permissions": [
 {
 "username": "example@cxense.com",
 "read": true,
 "write": true
 }
 ]
 }
 ]
}

Last updated: December 28, 2023