Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideRecipesAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

Retrieve content with Optimizely Graph

How to index Optimizely CMS (SaaS) content and content types to Optimizely Graph.

This section's topics show how Optimizely Content Management System (SaaS) content and content types are indexed to Optimizely Graph. For information about Optimizely Graph, see Get started with Optimizely Graph.

📘

Note

Restricted Content with Optimizely Graph

Restricted content refers to content that is not visible to all users. To designate content as restricted, you need to remove the "Read" permission for the "Everyone" group.

Indexing and Accessing Restricted Content

Restricted content is indexed into Optimizely Graph. However, it is not accessible when querying data from Optimizely Graph using single key authentication. To access restricted content, you must utilize either Basic or HMAC authentication.

Restricted Content in Content Areas

When a content area is indexed, any referenced content is "inlined" into the area. This allows you to query the content area as if the referenced content is part of it. Optimizely Graph does not evaluate user permissions at query time to verify access to content within a content area; this is determined during indexing.

Criteria for Content Appearance in Content Areas For content to be included in a content area, it must meet at least one of the following criteria:

  • The content is public (i.e., it has "Read" permission for the "Everyone" group).
  • The content is located in the "For this Page" folder.
  • The content has at least the same read permissions for all user groups as the content where the content area is placed. For nested content, permissions are verified against the top-level content.

Let's look at the example of the last criteria. If a page has read permissions for the WebAdministrators, editors1, and editors2 groups, and a block within the content area has read permissions for the editors1, editors2, and editors3 groups, the block will not be included in the content area. This is because it does not have read permissions for the WebAdministrators group.