Loading...
Area: Episerver CMS, Episerver Tracking
Applies to versions: Tracking.Core 1.6 and higher

Page view tracking

This topic describes the product-specific tracking integration for Episerver CMS. Use tracking in CMS to provide content recommendations, and for tracking data to any source for business intelligence data visualization purposes. 

Tracking

The tracking service supports product-specific tracking for Episerver CMS. Depending on the setup, you can track Episerver CMS data to any source, or to Episerver Profile Store. To get tracking running for a site, you need to configure access to the tracking API.

Installation and configuration

To learn about installing and getting started with tracking, see Install and configure tracking.

Schema and name for page view tracking in Payload

The following schema is used for page view tracking. It's possible to extend the tracking event with extra fields. It is important that the following fields are included in correct structure.

To get most out of the event, the name for page view tracking must be epiPageView. Several Episerver internal services will aggregate the known fields in the event with the event name epiPageView.

"epi": {
   "contentGuid": "",
   "language": "",
   "siteId": "",
   "ancestors": [],
   "recommendationClick": ""
}

Track page views using ITrackingService

There are several ways to enable Page view tracking. The best combination of freedom and schema rules is provided via the EPiServer.Tracking.PageView Nuget package in combination with the ITrackingService. The following example guides you through a class that tracks page views.

  1. Create the page view tracker class.
    public class PageViewTracker
    {
    }
  2. Add necessary dependencies to three classes:
    • ITrackingService. Sends the tracking data.
    • ISiteDefinitionResolver. Gets SiteId.
    • IContentLoader. Gets "Ancestors" for the page.
    private readonly ITrackingService _trackingService;
    private readonly ISiteDefinitionResolver _siteDefinitionResolver;
    private readonly IContentLoader _contentLoader;
    
    public PageViewTracker(
        ITrackingService trackingService,
        ISiteDefinitionResolver siteDefinitionResolver,
        IContentLoader contentLoader
        )
    {
        _trackingService = trackingService;
        _siteDefinitionResolver = siteDefinitionResolver;
        _contentLoader = contentLoader;
    }
  3. Create a method for tracking page views.

    Create an async method for sending page view tracking events. This lets you be async all the way. The method has two dependencies:

    • PageData. The page being tracked.
    • HttpContextBase. Needed in the Track method of  ITrackingService.
    public async Task Track(PageData pageData, HttpContextBase httpContextBase)
    {
    }
  4. Create an instance of EPiPageViewWrapper in the Track method.

    The EPiServer.Tracking.PageView package contains tracking models that help track page views in a specific way. Internal Episerver services can make greater use of page view tracking events when the schema is known.

    Use SiteDefinitionResolver to get the site for the content, and IContentLoader to get the ancestors.

    The EpiPageViewWrapper model is just a "wrapper" model, which contains a property named Epi of type EpiPageView. EpiPageView contains the necessary properties to be set:

    • ContentGuid.  Identifier of page being tracked.
    • Language. Language of page being tracked.
    • SiteId. Identifier of the site to which page belongs.
    • Ancestors. The page's ancestors.
    var site = _siteDefinitionResolver.GetByContent(pageData.ContentLink, true);
    var ancestors = _contentLoader.GetAncestors(pageData.ContentLink).Select(c => c.ContentGuid).ToArray();
    
    var pageDataTrackingModel = new EpiPageViewWrapper
    {
        Epi = new EpiPageView
        {
            ContentGuid = pageData.ContentGuid,
            Language = pageData.Language?.Name,
            SiteId = site.Id,
            Ancestors = ancestors,
        }
    };
  5. Create a method for getting UserData.

    You want to get the user's name and email address if possible. This example uses EPiServer.Security.PrincipalInfo for the name and EPiServer.Personalization.EPiServerProfile for the email.

    private static UserData CreateUserData(HttpContextBase httpContextBase)
    {
        var name = EPiServer.Security.PrincipalInfo.CurrentPrincipal?.Identity?.Name;
        var email = EPiServer.Personalization.EPiServerProfile.Current?.Email;
    
        return new UserData()
        {
            Name = name,
            Email = email
        };
    }
  6. Create a TrackingData instance.

    Create an instance of "tracking data," where the generic type is our tracking model. Then, set the following properties:

    • EventType. Schema name for the tracking event.
    • User. UserData created in the CreateUserData method.
    • Value. A human-readable text about the event that will be created.
    • Payload. An instance of the generic type, containing all properties with values needed for the specific event.
    var value = $"Viewed {pageData.Name}";
    var user = CreateUserData(httpContextBase);
    
    var trackingData = new TrackingData<EpiPageViewWrapper>
    {
        EventType = "epiPageView",
        User = user,
        Value = value,
        Payload = pageDataTrackingModel
    };
  7. Send tracking data.

    Call the tracking service with the tracking data and HttpContextBase.

    await _trackingService.Track(trackingData, httpContextBase);

PageViewTracking class

The following code is a summary of the whole class.

public class PageViewTracker
{
    private readonly ITrackingService _trackingService;
    private readonly ISiteDefinitionResolver _siteDefinitionResolver;
    private readonly IContentLoader _contentLoader;

    private const string FormsTrackingEventType = "epiPageView";

    public PageViewTracker(
        ITrackingService trackingService,
        ISiteDefinitionResolver siteDefinitionResolver,
        IContentLoader contentLoader
        )
    {
        _trackingService = trackingService;
        _siteDefinitionResolver = siteDefinitionResolver;
        _contentLoader = contentLoader;
    }

    public async Task Track(PageData pageData, HttpContextBase httpContextBase)
    {
        var site = _siteDefinitionResolver.GetByContent(pageData.ContentLink, true);
        var ancesctors = _contentLoader.GetAncestors(pageData.ContentLink).Select(c => c.ContentGuid).ToArray();

        var pageDataTrackingModel = new EpiPageViewWrapper
        {
            Epi = new EpiPageView
            {
                ContentGuid = pageData.ContentGuid,
                Language = pageData.Language?.Name,
                SiteId = site.Id,
                Ancestors = ancesctors,
            }
        };

        var value = $"Viewed {pageData.Name}";
        var user = CreateUserData(httpContextBase);

        var trackingData = new TrackingData<EpiPageViewWrapper>
        {
            EventType = FormsTrackingEventType,
            User = user,
            Value = value,
            Payload = pageDataTrackingModel
        };

        await _trackingService.Track(trackingData, httpContextBase);
    }

    private static UserData CreateUserData(HttpContextBase httpContextBase)
    {
        var name = EPiServer.Security.PrincipalInfo.CurrentPrincipal?.Identity?.Name;
        var email = EPiServer.Personalization.EPiServerProfile.Current?.Email;

        return new UserData()
        {
            Name = name,
            Email = email
        };
    }
}

Using the PageViewTracking class

You can use the PageViewTracking class from any part of the site where HttpContext is available. The following is an example of using the class from an async controller action.

private readonly PageViewTracker _pageViewTracker;

public MyController(PageViewTracker pageViewTracker)
{
    _pageViewTracker = pageViewTracker;
}

public async Task<ActionResult> Index(PageData currentPage)
{
    await _pageViewTracker.Track(currentPage, HttpContext);

    var model = PageViewModel.Create(currentPage);
    return View(model);
}

Track page views using a tracking attribute

An alternative to ITrackingService is to use a tracking attribute. Add the PageViewTracking attribute to your controller, and the page will be tracked.

[PageViewTracking]
public ActionResult Index(StartPage currentPage)
{}
 
[ValidateInput(false)]
[PageViewTracking]
public ViewResult Index(SearchPage currentPage, string q)
{}]]

Related topics

Last updated: Mar 11, 2019

Feedback?