Walkthrough: Creating a custom Experience Analytics report

Current version: 10.3

Sitecore Experience Analytics provides dashboards and reports for marketers and marketing analysts to identify patterns and trends in experience data. This data is collected from websites and other external data sources.

You can create an experience analytics report from scratch using Microsoft Visual Studio and Sitecore Rocks.

This walkthrough outlines how to:


If you want to change or customize a standard report that comes with Experience Analytics, it is best practice to copy an existing report, customize it, and then rename it. This is due to possible changes in standard reports in future versions of Sitecore.

Create a new report page item

Add a new report page to the content tree. A report page contains other subitems that you need when you configure your report.


You need to install Microsoft Visual Studio with Sitecore Rocks, and a suitable Sitecore website to complete this task.

To create a report page:

  1. Open Sitecore Rocks and create a connection to your website.

  2. In the website content tree, navigate to the Dashboard node using the following path:


  3. To add a new report page under this item, select a report category, for example, Acquisition. Right click the category, click Add, and then click New Item.

  4. In the New Item dialog box, click All to see all available SPEAK report templates.

    To find all available report templates, enter a search term beginning with experienceanalytics.

  5. Select the ExperienceAnalyticsReportPage. You can accept the default name or provide a name for the item, for example, TestReportPage.

  6. Click OK to save your changes.

    Your new report page appears in the content tree below the category, for example, Acquisition, and it also contains a PageSettings subitem.

Add a chart component to a report

Before you can add a chart component to a report, you first need a report page.

To add a chart component to a report page:

  1. In Sitecore Rocks, right-click a report page, click Tasks and then click Design Layout.

  2. In the Design Layout window, click AddRendering.

  3. In the Select Rendering dialog box, select a chart control to use in your report page.

    To find all available chart controls, enter a search term beginning with experienceanalytics. You can choose from an area chart, bar chart, list, or line chart. For example, to display a bar chart, select the ExperienceAnalyticsBarChart rendering.

  4. Choose a chart type and click OK to save your changes.

Add a parameters item to the report

You need a parameters item to configure report metrics and other settings in your chart. A parameters item is a subitem of the PageSettings item.

To add a parameters item:

  1. On the report page, right-click the PageSettings item and click Add - New Item.

    To find all available chart parameter controls, enter a search term beginning with experience analytics. You can see parameters items for each type of chart control. For example, if you are using the bar chart control, select the ExperienceAnalyticsBarChartParameters item.

  2. You can enter a name for your parameters item or accept the default name, then click OK.

  3. To configure the parameters item, double click the item to open it.

  4. In the parameters item, select a metric and add a segment to your chart.

  5. In the parameters item, fill in the Dimension field.


    This information is needed when a user filters the report using a segment from List Manager.

    For example, to show conversions from all visits by country, select the following:

    • Metric = Conversions

    • Segment = All visits by Country

    • Dimension = Dimensions/Visits/By country

  6. Save your changes.

Bind the bar chart control to the parameters item

If you do not bind the bar chart control to the parameters item, your report will not display any data.

To bind the ExperienceAnalyticsBarChart control to the parameters item:

  1. Right-click the report, click Task, Design Layout, and then double-click the chart item that you have created. For example, double click the ExperienceAnalyticsBarChart control.

  2. In the Edit Rendering Properties dialog box, in the Behavior section, in Data Source, browse to the location of the ExperienceAnalyticsBarChartParameters item in the content tree.

  3. Select the parameters item and click OK.

  4. Save your changes.

Change the chart title

Your new chart needs a heading to describe the content that it displays.

To change a title label on a chart:

  1. Double-click the parameters item for your chart.

  2. In the parameters item, expand the Appearance section.

  3. In the Title field, enter the relevant title, for example, Conversions by country.

  4. Save your changes and view the chart in Experience Analytics.

Test the report

When you have successfully created your new report, open Experience Analytics and preview the report in a web browser.

To test the report:

  1. Open the Experience Analytics dashboard.

  2. Navigate to the relevant tab and select your new report.

  3. If you do not see anything in your report, select a wider date range of data and all sites.

Do you have some feedback for us?

If you have suggestions for improving this article,