Response Structure

AVAILABLE API VERSION
API v67.0 and later

The Managed Content API uses several types to represent search results, content items, and channel delivery information. This guide describes the schema structure and field definitions.

The ManagedContentSearchResultPage type is the top-level response object that contains paginated search results.

The ManagedContentSearchResultPage type contains these fields.

  • total - Total number of matching results across all pages
  • offset - Zero-based offset of the first item in this result page
  • pageSize - Number of items returned per page
  • items - Array of content items in this result page

The ManagedContentSearchResultItem type represents individual content items in the search results.

The ManagedContentSearchResultItem type contains these fields.

  • managedContentId - Unique identifier for the CMS content item, such as 20Yxx000000001XEAQ
  • managedContentKey - Content key used for deduplication across channels
  • title - Title of the CMS content item
  • contentType - Fully qualified name of the content type, such as news, sfdc_cms__image
  • language - IETF-style locale code indicating the language variant, such as en_US, fr
  • taxonomies - Array of associated taxonomy term identifiers
  • managedContentChannelDeliveryDetails - Array of delivery details for each CMS channel where the content is published

The ManagedContentChannelDeliveryDetails type contains channel-specific delivery information for content.

The ManagedContentChannelDeliveryDetails type contains these fields.

  • managedContentChannelDetails - Information about the channel
  • contentUrl - URL where the content is accessible on the channel
  • publishedDate - Date string that indicates when the content item was published to the channel. The date is in ISO 8601 format.

The ManagedContentChannelDetails type contains information about the CMS channel where the content was published.

The ManagedContentChannelDetails type contains these fields.

  • id - Unique identifier for the channel, such as 0apxx000000001XAAQ
  • name - Name of the channel
  • type - The channel type, such as public

Here’s an example of a complete search response.