Content widget content configuration object

A content widget content configuration object (or simply "content configuration") specifies the content of some widgets (i.e. what kind of recommendations you want). There is a basic user interface for creating managing content configurations, but it is also possible to use the API directly. Observe several widgets may use the same content configuration. You may also have content configurations that are not used by any widgets.

A content configuration may have the following fields. If a field is not specified when the configuration is created, its value will be null. If a field is not specified in an update, this field's value will not be changed. If a field is missing when read back from the server (in the response to a create, read or update), it means that its value is null.

Name	Type	Description
`id`	String	Identifier of the configuration.
`siteGroupId`	String	Site group of this configuration. If not present, the configuration is global, and can only be imported into other configurations, not be used directly in a widget.
`description`	String	Short description of the configuration.
`settings`	Object	A content settings object containing detailed settings for this configuration.
`lastUpdatedBy`	String	Email address of the last person to update the configuration.
`lastUpdatedAt`	String (Date)	Time of the last update to the configuration (ISO 8601 timestamp).
`annotations`	Array of Object	Array of key value pair objects. Used for storing custom metadata.
history	Array of Object	List of previous configurations.

Annotations

List of key value pairs. Max size of list is 1000.

Name	Type	Description
key	String	Must be unique and less than 256 characters. Must start with a letter and can only contain ascii characters a-z, A-Z, 0-9 or _ (underscore).
value	String	Less than 256 characters

Notes

If lastUpdatedBy and/or lastUpdatedAt is specified when the object is created, it has no effect. But if this is specified in an update, it has to match the current values for the update to succeed. This can be seen as a form of optimistic concurrency control. However, we cannot currently make any guarantees when there are several conflicting updates to the same object at the same time.
The history field is only included in the response when individual configurations are read or updated, and only if changes have been made to this object since December 8, 2013 (when this field was added). It contains up to 50 previous revisions of the configuration, in reverse chronological order. These revisions are themselves configuration objects – except that they do not contain the fields id, siteGroupId and history. The history field is ignored when a configuration is created or updated.

Content settings object

This information has been moved to a separate page.

Last updated: December 28, 2023