Skip to main content

The event object model

Abstract

Describes a list of required keys used for event objects.

The event object is a dictionary of key-value pairs representing data about the event being recorded, the user, the device, and so on.

The following table lists top-level attributes that are required for all Sitecore Discover event objects. Depending on the type of event, there might be other required attributes located within the value object.

Name

Type

Description

type

String

Type of the event

name

String

Name of the event

value

Object

Event value object

The following table lists other keys that are only required when you are using the Sitecore Discover Events API:

Name

Type

Description

t

Integer

Required.

Time of the event in milliseconds.

t0

Integer

Required.

Time the page loaded in milliseconds.

uuid

String

Either uuid or user_id is required.

Unique Discover-provided user ID

user_id

String

Either uuid or user_id is required.

Unique, anonymous user ID

The following table lists optional keys:

Name

Type

Description

Value

device

String

Optional.

Device type.

  • pc

  • mobile

  • tablet

app_type

String

Optional.

Application type.

  • native

  • webview

  • browser