1. GraphQL

Sitecore Experience Edge for XM Preview GraphQL endpoint

Version:

The Sitecore Experience Edge for XM Preview GraphQL endpoint is a GraphQL endpoint based on the Sitecore GraphQL API. The endpoint mirrors the schema and behavior of Sitecore Experience Edge for XM. It enables preview, editing, and local development without publishing to Experience Edge.

Note

The Preview GraphQL endpoint endpoint uses a tokenized search index. As a result, search behavior depends on how fields are indexed:

  • The CONTAINS operator can return multiple results based on tokenized field values.

  • The EQ (Equals) operator may also return multiple results for tokenized text fields, even when an exact match is expected.

To ensure exact matching with EQ in the Preview endpoint, use the SearchQueryFieldMapping feature to map tokenized fields to non-tokenized computed fields. See also the related support article KB1003665.

For information about search operators behavior, see Search operators.

The following topics describe how to use the Preview GraphQL endpoint:

Important

We do not support extending the mirrored schema on your Sitecore CM and CD roles. Extending the schema would break compatibility with Experience Edge. If you want custom schemas, use the Sitecore GraphQL API.

When performing search queries using the Preview endpoint, there are additional fields available compared to querying the Experience Edge endpoint. Therefore, for search queries against the Experience Edge endpoint, use only the fields described in the Experience Edge documentation.

If you have suggestions for improving this article, let us know!