Implement Experience APIs on Your Site or App

Experience APIs enable you to implement Dynamic Yield via server-side APIs. The APIs cover all aspects of implementation, from tracking pageviews, assigning targeted experiences, and tracking clicks and events.

Working with Experience APIs means you take more responsibility for the implementation, but gain more flexibility, while also reducing the impact of scripts on page loading time.

On your website, you can use Experience APIs in parallel to the script-based client-side implementation. For example, you can implement the script and events on the client-side, but run all (or some) of your campaigns via server-side implementation.

On your mobile apps, implementation is fully via Experience APIs.

Things to know before you start

  • Documentation: Experience APIs are documented in the API Reference.
  • Eligibility: To work with Experience APIs, you must have full access to your code base. For example, the classic Shopify platform (as opposed to Shopify Hydrogen) doesn't allow you full access, and therefore, a Shopify site can't use Experience APIs.
  • Caching and page performance: In web development, it's standard to use caching for static assets to enhance performance. However, personalization requires dynamic content, which changes for each user, and even within the session. We recommended using techniques like fragment caching to re-render only the dynamic parts of the page. If the dynamic portion of the page is below the fold and can be loaded asynchronously, you can decide to load that part as a separate process after you've displayed the cached above-the-fold content.
  • Server location: If your account uses our EU data center, servers are located in the AWS Frankfurt data center, also known as eu-central-1 region. For accounts using the US data center (Experience OS console domain ends with .com), the server is located in the AWS North Virginia data center, also known as us-east-1 region.