Read or list content widget content configuration objects. (See API authentication for general information how to use these APIs.)
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
id |
String |
No |
Retrieve the content configuration with the given identifier. |
|
siteGroupId |
String |
No |
Retrieve all content configurations with the given site group. |
|
fullHistory |
Boolean |
No |
If false, do not include the fields |
At most one of id and siteGroupId can be specified. If neither are specified, global content configurations without siteGroupId are returned.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
contents |
Array of Object |
Array of content configuration objects . |
If 'id' was specified in the request, this array contains at most one element.
Example
$ cx.py /widget/content '{ "id": "74732be6b5b79f0953f6606870aad034369ed528" }'
{
"contents": [
{
"siteGroupId": "9222300742653756873",
"id": "74732be6b5b79f0953f6606870aad034369ed528",
"description": "My first widget content configuration",
"lastUpdatedBy": "ivar.rummelhoff@cxense.com",
"lastUpdatedAt": "2013-08-21T10:52:17.048Z",
"settings": {
"type": "recs",
"siteIds": [
"9222300742735526873"
],
"matchingMode": {
"contextual": {
"weight": 9
},
"trend": {
"weight": 1
}
},
"resultFields": [
"url",
"title",
"description",
"dominantthumbnail"
],
"maxAge": 129600
}
}
]
}