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.

Response Structure

ManagedContentSearchResultPage Type

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

1type ManagedContentSearchResultPage {
2  total: Int!
3  offset: Int!
4  pageSize: Int!
5  items: [ManagedContentSearchResultItem!]!
6}

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

ManagedContentSearchResultItem Type

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

1type ManagedContentSearchResultItem {
2  managedContentId: ID!
3  managedContentKey: String!
4  title: String!
5  contentType: String!
6  language: String
7  taxonomies: [String!]
8  managedContentChannelDeliveryDetails: [ManagedContentChannelDeliveryDetails!]
9}

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

ManagedContentChannelDeliveryDetails Type

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

1type ManagedContentChannelDeliveryDetails {
2  managedContentChannelDetails: ManagedContentChannelDetails!
3  contentUrl: String
4  publishedDate: String
5}

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.

ManagedContentChannelDetails Type

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

1type ManagedContentChannelDetails {
2  id: ID!
3  name: String!
4  type: String
5}

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

Example Response

Here’s an example of a complete search response.

1{
2  "data": {
3    "managed_content": {
4      "search": {
5        "searchContentInChannels": {
6          "total": 42,
7          "offset": 0,
8          "pageSize": 10,
9          "items": [
10            {
11              "managedContentId": "20Yxx000000001XEAQ",
12              "managedContentKey": "product-announcement-2024",
13              "title": "New Product Launch Announcement",
14              "contentType": "news",
15              "language": "en_US",
16              "taxonomies": ["terms/product-news", "terms/announcements"],
17              "managedContentChannelDeliveryDetails": [
18                {
19                  "managedContentChannelDetails": {
20                    "id": "0apxx000000001XAAQ",
21                    "name": "Customer Portal",
22                    "type": "public"
23                  },
24                  "contentUrl": "https://example.com/content/product-announcement-2024",
25                  "publishedDate": "2024-03-15T10:30:00Z"
26                }
27              ]
28            }
29          ]
30        }
31      }
32    }
33  },
34  "errors": []
35}

Response Structure