Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Introduction to Sitecore Personalize
Managing accounts and system settings
Identifying guests
Introduction to experiments
Introduction to experiences
Decisioning
View dashboards
Developer Center
Connecting to an external system
Using client-side JavaScript
Using server-side JavaScript
AI in Personalize
Glossary
  • Sitecore Personalize
  • Introduction to experiences
  • Introduction to web experiences in Sitecore Personalize
  • Compose the API request for a web experience
  • Test the API request for a web experience

Test the API request for a web experience

After you compose the API request of your web experience, you can use the Preview API button to test it. You can verify if the API retrieves the correct attributes in response to the experience you are running against a selected guest.

To test the API request:

  1. In the code editor, click Preview API.

  2. In the Test Condition dialog, under the Guest option, click the search field to find the guest you want to test against. You can do this in several ways:

    • Select an identifier type in the search dropdown, such as Email. Then, enter the corresponding identifier, such as the email address of the visitor or customer, then select the guest from the search results.

    • Use Quick Select to automatically choose a Visitor or a Customer.

    • To access recently searched guests, click the Recent option and select a guest from the list.

    • To access bookmarked guests, click the Bookmarks option and select a guest from the list.

    The guest request is displayed showing the available guest attributes to include in the API request. This is useful if you're including guest attributes as parameters in the API request, and want to ensure you're entering the correct path.

    Selecting a specific guest for API request testing in a web experience displays the guest attributes.
  3. Optionally, click the Experience request option to select a specific point of sale and add any necessary headers and parameters for your test.

  4. Click Test.

  5. On the Response tab, verify that the API response includes all required attributes, such as the guest's currency and point of sale. This response is what Sitecore Personalize returns based on the experience running against the selected guest.

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2026 Sitecore