Setup and health

The "Setup and health" tab in Contentful Personalization provides a step-by-step guide that enables you to correctly configure your setup for experimentation, personalization, and analytics. It replaces manual, scattered configuration with a guided checklist.

NOTE: The checklist has three steps that you must complete in order.

Following the guidance from the "Setup and health" tab, you can reach a working setup faster and with more confidence. This feature makes setup up easier to understand, and, once complete, it gives teams a way to monitor whether their implementation stays healthy over time.

You can access the Setup and health tab from the Contentful Personalization app configuration.

To access the "Setup and health" tab:

1. Log in to the Contentful web app.

2. Click Apps, and select Installed apps. The list of apps installed in your environment is displayed.

3. Click Configure next to Contentful Personalization. The “Setup and health” tab is displayed on the app configuration page.
   

   

To complete the Setup and health checklist:

Step 1: Configure your data bucket and content types

1. Click Go to data buckets to connect the data bucket, and choose where analytics data is stored.
   

   

   
   The “Data buckets” tab is displayed.
   

   

2. Select the content types you want to be personalized.
   

   

   
   The “Personalizable content types” tab is displayed.
   

   

3. Select the content types you want to be measured. The “Analytics content types” tab is displayed.
   

   

   
   Once you have connected the data bucket and selected the content types, the step is marked as complete, and you can move on to the next one.
   

   

Step 2: Create a test audience and personalization

1. Under “Create test audience”, click Create to have a test audience automatically created.
   

   

   NOTE: You don't have to name or configure it, everything is pre-configured. You can delete this audience later on.

2. Under “Choose content entry for the baseline”, click Select to choose a baseline content entry, for example, an existing hero banner or landing page.
   

   NOTE: The baseline content entry you choose determines where on your site the test personalization renders. Use that page to verify your SDK implementation is tracking events correctly. 

3. Under “Choose entry for your variant”, click Select to choose a variant content entry that your test audience will see, for example, a new call-to-action.

4. Under “Create test personalization”, click Create to link your baseline, variant, and test audience together.
   

   NOTE: You don't have to name or configure it, everything is pre-configured. You can delete this personalization later on.

5. Review the changes, and click Publish.
   

   

   Once you click Publish, the step is marked as complete, and you can move on to the next one.

Step 3: Implement the SDK and verify events flow

1. Click Set up tracking to implement the SDK required for your setup.
   

   

   Follow the guided SDK installation, either using the installation guide or the AI skills.
   

   

2. Click Continue. The “Verify tracking” page is displayed.
   

   

3. Wait for Contentful to automatically check for incoming events.

4. Test your setup by accessing the website or preview environment using the URL parameter. The created test personalization is triggered when visiting the website with the ?utm_source=test&utm_medium=setup parameter attached. For example, {your URL}/?utm_source=test&utm_medium=setup.
   

   NOTE: If events are already flowing from an existing implementation, this step can be completed without waiting on events from your new test personalization.

Once all steps are complete, the checklist collapses and the tab displays your ongoing health view.

After setup, use the health view in the Setup and health tab to confirm your implementation is still working correctly.

To monitor your setup health: 

1. Log in to the Contentful web app.

2. Navigate to the "Setup and health" tab in the Contentful Personalization app configuration.

3. Review the Optimization health view, which displays:

   1. Whether you're running an outdated Experience SDK version.
      

      NOTE: This is only applicable if you are using the Experience SDK. We currently do not display the same details if you are using a different SDK. 

   2. The number of audiences, experiences, and metrics you have configured.

   3. Whether events are currently being received.

   4. How fresh your data is.

NOTE: We recommend checking this view periodically, especially if personalization results seem stale or you suspect a tracking issue. It's the fastest way to confirm whether events and SDKs are correctly configured.