experienceevent.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/experienceevent",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "ExperienceEvent",
  "type": "object",
  "meta:extensible": true,
  "description":
    "The core ExperienceEvent XDM is used to capture observations that are altering one or more related XDMs/entities. The ExperienceEvent captures information about the observation taking place and when it is occurring. It is critical for time domain analytics as it allows observation and analysis of changes that occur in windows of time and comparison with other windows of time to track trends. ExperienceEvent are either explicit or implicit. Explicit events are direct observations of a human action taking place during a session. Implicit events are events that are being raised without a direct human action. Examples of implicit events are scheduled email sending of newsletters, battery voltage reaching a certain threshold, a person entering into range of a proximity sensor. While not all events are easily categorized across all data sources, it is extremely valuable to harmonize similar events into similar types for processing where possible, and the XDM specifications does this by defining a set of enumerated **type** attribute values with specific semantic meanings. Where possible events must be constrained to these enumerated values to facilitate interoperability.",
  "definitions": {
    "experienceevent": {
      "properties": {
        "@id": {
          "title": "Identifier",
          "type": "string",
          "format": "uri",
          "description": "The unique identifier for the ExperienceEvent."
        },
        "xdm:dataSource": {
          "title": "Data Source",
          "$ref": "https://ns.adobe.com/xdm/data/datasource",
          "description": "Globally unique identification of a data source."
        },
        "xdm:timestamp": {
          "title": "Timestamp",
          "type": "string",
          "format": "date-time",
          "description":
            "The time when the first event of the interaction occurred."
        },
        "xdm:receivedTimestamp": {
          "title": "Received Timestamp",
          "type": "string",
          "format": "date-time",
          "description":
            "The time at which this interaction was received by a server."
        },
        "xdm:endUserIDs": {
          "title": "End User IDs",
          "$ref": "https://ns.adobe.com/xdm/context/enduserids",
          "description":
            "Condensed, normalized encapsulation of all end user identifiers."
        },
        "xdm:environment": {
          "title": "Environment",
          "$ref": "https://ns.adobe.com/xdm/context/environment",
          "description":
            "Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions."
        },
        "xdm:productListItems": {
          "title": "Product List Items",
          "type": "array",
          "description":
            "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.",
          "items": {
            "$ref": "https://ns.adobe.com/xdm/content/productlistitem"
          }
        },
        "xdm:device": {
          "title": "Device",
          "$ref": "https://ns.adobe.com/xdm/context/device",
          "description":
            "An identified Device/Application or Device/Browser instance that is trackable across sessions, normally by cookies."
        },
        "xdm:commerce": {
          "title": "Commerce",
          "$ref": "https://ns.adobe.com/xdm/context/commerce",
          "description":
            "The commerce specific data related to this interaction."
        },
        "xdm:application": {
          "title": "Application",
          "$ref": "https://ns.adobe.com/xdm/context/application",
          "description":
            "The application related to the event observation. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login."
        },
        "xdm:search": {
          "title": "Search",
          "$ref": "https://ns.adobe.com/xdm/context/search",
          "description": "The information related to web or mobile search."
        },
        "xdm:web": {
          "title": "Web",
          "$ref": "https://ns.adobe.com/xdm/context/webinfo",
          "description":
            "The information related to web page and link of the ExperienceEvent."
        },
        "xdm:directMarketing": {
          "title": "Direct Marketing",
          "$ref": "https://ns.adobe.com/xdm/context/direct-marketing",
          "description":
            "The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications."
        },
        "xdm:marketing": {
          "title": "Marketing",
          "$ref": "https://ns.adobe.com/xdm/context/marketing",
          "description":
            "The information related to marketing activities that are active with the touchpoint."
        },
        "xdm:placeContext": {
          "title": "Place Context",
          "$ref": "https://ns.adobe.com/xdm/context/placecontext",
          "description":
            "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours."
        },
        "xdm:channel": {
          "title": "Experience Channel",
          "description":
            "The experience channel related to this ExperienceEvent.",
            "$ref": "https://ns.adobe.com/xdm/channels/channel"
        },
        "xdm:advertising": {
          "title": "Advertising",
          "$ref": "https://ns.adobe.com/xdm/context/advertising",
          "description": "The information related to advertising activity related to the experience event"
        },
        "xdm:media": {
          "title": "Media",
          "meta:status": "experimental",
          "$ref": "https://ns.adobe.com/xdm/context/media",
          "description": "The media activity information related to the experience event"
        }
      },
      "required": ["@id", "xdm:timestamp", "xdm:endUserIDs"]
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/experienceevent"
    }
  ],
  "meta:status": "stabilizing"
}