Warning: Altis v12 is no longer supported.

Personalization API

Altis empowers editorial teams to create personalized content with the Personalized Content Experience Block. Because it is crucial that web pages can be fully cached for performance, our Personalized Content blocks use web components that are simple to use and load immediately as the document is loaded.

These blocks can be created through the editor or programmatically as described on this page.

The web component <personalization-block> can be used anywhere on your pages to show content conditionally according to the audience segments the current website visitor matches.

The markup makes use of the <template> tag along with the web component and data attributes. <template> tags can contain any markup however that markup will remain inert until the contents are cloned into another DOM node. This means images, iframes and script tags for example will not try to load any resources until they are cloned.

<template data-audience="1" data-parent-id="abcdef">
	<p>Content to show to audience 1</p>
<template data-audience="2" data-parent-id="abcdef">
	<p>Content to show to audience 2</p>
<template data-fallback data-parent-id="abcdef">
	<p>Fallback content for everyone else</p>
	<p>Fallback content for everyone else</p>
<!-- The HTML tag can not be self-closing. -->
<personalization-block client-id="abcdef"></personalization-block>
  • The <personalization-block> must have a unique client-id attribute.
  • The <personalization-block> must come after the associated templates.
  • The <template> tags data-parent-id must match the <personalization-block> client-id attribute.
  • A <template> tag with a data-fallback attribute can be optionally added to provide default content.
  • The <template> tags must have either a data-audience attribute with the audience ID as a value or a data-fallback attribute to be used.

The audiences a visitor falls into are determined automatically on each visit to your site. The audience IDs they belong to are accessible using the following JavaScript:

// Array of audience IDs.
const audiences = Altis.Analytics.getAudiences();

If the visitor's audiences are updated for any reason, for example a registerAttribute() or updateEndpoint() call results in a change to the data then an update event is fired that can be subscribed to as follows:

Altis.Analytics.on( 'updateAudiences', function ( audiences ) {
	console.log( 'New audiences', audiences );
} );

This method is used to update the <personalization-block> tags automatically in the event of a visitor's audiences changing.