Analytics for Personalization users
Table of contents
- Introduction
- Step 1: Select content types to extend with Contentful Analytics dashboards
- Step 2: Install the Insights Plugin
- Step 3: Wrap additional components in
<EntryAnalytics /> - Step 4: Validate your integration
- Step 5: Enable Built-in AI Features for the Analytics Agent
Introduction
This guide explains how Contentful Personalization customers can use their existing integration to quickly implement Contentful Analytics.
This guide assumes that your application implements Contentful Personalization in a React-based frontend. It covers the following steps:
- Select the content types to extend with Contentful Analytics dashboards.
- Install the Insights Plugin. Use version 7.17.6 or later.
- Optional: Wrap additional components in
<EntryAnalytics />. - Validate your integration.
- Enable Built-in AI Features.
Step 1: Select content types to extend with Contentful Analytics dashboards
You decide what content types display Content Analytics dashboards by enabling them:
- Log in to the Contentful web app.
- Navigate to the “Content model” tab.
- Select the content type you want to enable entry-level analytics for (e.g., Page).
- In the left sidebar, click Entry editors.
- Under “Available items”, add the installed Contentful Personalization app.
- Click Save. The “Analytics” tab is displayed in the entry editor for any entry of that content type.
Step 2: Install the Insights Plugin
Identify the Experience SDK version that you're using and install the Insights Plugin.
Step 3: Wrap additional components in <EntryAnalytics />
The Experience SDK provides the following components that can be used to wrap your React components: <EntryAnalytics /> and <Experience />.
A wrapped component will automatically send a component event to the Experience API if a user views it.
Contentful Analytics will then use these events to calculate actionable insights.
- Wrap content in an
<Experience />component if you want to enable both Contentful Personalization and Contentful Analytics for it. - Wrap content in an
<EntryAnalytics />component if you exclusively want to enable Contentful Analytics for it.
<Experience /> or <EntryAnalytics /> component is ignored by Contentful Analytics.
Step 4: Validate your integration
We recommend using our Live Events view to validate your integration of Contentful Analytics.
To access the Live Events view:
- Log in to the Contentful web app.
- Navigate to the “Optimization” tab.
- In the left sidebar, click Live Events.
- Enable the Live event streaming toggle.
The Events dashboard displays the type of events that Contentful Analytics receives over time, and the Event streaming log lists invidivual events.
Step 5: Enable Built-in AI Features for the Analytics agent
The Analytics Agent is the AI assistant that allows you to ask contextual questions about your content and instantly receive AI-powered content answers, both as text and visual elements. The Analytics Agent relies on Contentful's AI features, so you must first enable them at the organization level.
To enable AI features at the organization level:
- Log in to the Contentful web app.
- Navigate to the “Optimization” tab.
- In the left sidebar, click Analytics Agent.
- Click Go to Organization Settings.
- Click Continue to organization settings.
- Enable the Built-in AI Features option.
- Review the pricing and number of approved output words modal, then click Enable.
- Review Contentful’s AI Terms of Service. If you agree, click Accept terms to enable Built-in AI features.