Tracking Service

The Tracking Service is installed but disabled by defaultwhen installing Sitecore Headless Services.

To enable the Tracker, set the Sitecore.JSS.TrackerServiceEnabled setting to true in a configuration patch file, for example:

<configuration>
  <sitecore>
    <settings>
      <setting name="Sitecore.JSS.TrackerServiceEnabled" value="true" />
    </settings>
  </sitecore>
</configuration>

The tracker utilizes SSC API keys just like other services. The API keys help enable CORS support for the Tracker. It is good practice to use one API key for each app, but you can use the same API key for all its services.

You can track events using the endpoint /sitecore/api/jss/track/event?sc_apikey=[key].

The endpoint accepts POST requests with JSON payloads.

The following table shows the types of events you can track and the payload you must send to the Tracking Service endpoint:

{
    "goalId": "<goal ID>"
}

{
    "outcomeId": "<goal ID>", 
    "currencyCode": "<currency code>",
    "monetaryValue": "<monetary value>"
}

{
    "pageId": "<page ID>",
    "url": "<page URL>"
}

{
    "campaignId": "<campaign ID>"
}

{
    "eventId": "<event-value>"
}

You can view the data pushed by your tracking code in the Experience Profile.

By default, Sitecore does not index anonymous contact data, which means non-identified users do not have their data in the Experience Profile. To see your testing results more efficiently, you can enable the indexing of anonymous contacts.

The Tracker Service does not support identifying contacts out of the box, but you can extend it.

Sitecore does not store or index the tracked data into the Experience Profile before the end of the user session. To end the user session, invoke the endpoint /sitecore/api/jss/track/flush.

The tracker is a tracking data conduit, and you extend it as needed. The trackEvent pipeline, defined in App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Tracker.config is responsible for handling incoming tracking requests.

You can use a configuration patch to include new or replaced pipeline processors.

Processors must derive from Sitecore.JavaScriptServices.Tracker.Pipelines.TrackEvent<T>, where T is a C# type to deserialize the incoming JSON.

The pipeline processor TrackEvent method must: