Skip to main content

Debug a guest event in Sitecore Personalize

Abstract

Explains how to use the Event Debug in Sitecore CDP.

You use the Event Debug screen to debug specific events and monitor general platform health. The screen shows a table of recent events for a selected guest, and the details of each event. Events are shown for the past hour.

To use the debug screen:

  1. In the navigation pane, click the Event Debug menu item. The Event Debug screen displays.

    Event Debug screen in Sitecore Personalize.
  2. You can choose to show the screen for a random guest or select a guest of your choice. The former option is useful for checking general platform health, and the latter is used to check recent events of a specific guest.

    • To select a random guest, click Quick Select Customer or Quick Select Visitor. The system selects a guest who was recently active.

    • To select a specific guest, enter their identifier into the search box.

  3. By default, all events that were recorded for this guest in the past hour are shown. To view only failed events, click Failed. To view only successful events, click Success.

  4. If the event is an experience, you can click the experience name to open it.

  5. To view all events captured for a particular session, click the session name.

  6. To open the event details in a key-value table format, click the eye icon.

    Event details screen in Sitecore CDP

    The following details appear for most events:

    Attribute

    Description

    Browser Ref

    An identifier of the browser used in this event.

    Channel

    The channel captured during this event.

    Client Key

    Your organization's client key.

    Created At

    The time at which the event was first ingested into Sitecore CDP.

    Modified At

    The time at which the event was fully processed.

    Point of Sale

    The point of sale (storefront) at which the event occurred.

    Ref

    An identifier of this event.

    Session Ref

    An identifier of the session during which this event occurred.

    Status

    The status of the event processing. For most events, even failed ones, the status is PROCESSED.

    Type

    The event type.

  7. To view the details as a JSON object, click Show as JSON in the event details screen. The following is an example JSON structure of an event:

    {
      "ref": "cc123-123-***-***-***",
      "clientKey": "***",
      "createdAt": "2022-03-31T08:15:05.199Z",
      "modifiedAt": "2022-03-31T08:15:05.220Z",
      "type": "TRACKING",
      "status": "PROCESSED",
      "channel": "WEB",
      "pointOfSale": "retailsite.com",
      "browserRef": "***-***-***-***-***",
      "sessionRef": "***-***-***-***-***",
      "flowExecutionRef": "***-***-***-***-***",
      "arbitraryData": {
        "flowExecution": {
          "ref": "***-***-***-***-***",
          "occurredAt": 1648714504380,
          "flowRef": "***-***-***-***-***",
          "flowFriendlyId": "modal_pop_up",
          "flowVariantRef": "***-***-***-***-***",
          "guestRef": "***-***-***-***-***",
          "flowExecutionTimeMs": 2381,
          "status": "SUCCESS",
          "decision": {
            "decisionModelRef": "***-***-***-***-***",
            "decisionModelVariantRef": "***-***-***-***-***",
            "decisionModelExecutionTimeMs": 2306,
            "results": [
              "{\"ruleId\":\"NBO_2\",\"search1\":\"discount\",\"search2\":\"shoes\",\"search3\":\"bag\",\"search4\":\"accessories\"}"
            ]
          }
        },
        "category": "EXECUTED"
      },
      "flowExecution": {}
    }
  8. To view new data, you can click the refresh button at the top right.