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": "XDM ExperienceEvent",
  "type": "object",
  "meta:extensible": true,
  "meta:abstract": true,
  "meta:extends": [
    "https://ns.adobe.com/xdm/data/time-series",
    "https://ns.adobe.com/xdm/context/identitymap"
  ],
  "description": "An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends.",
  "definitions": {
    "experienceevent": {
      "properties": { 
        "xdm:eventMergeId": {
          "title": "ExperienceEvent merge ID",
          "type": "string",
          "description": "An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion."
        }
      }
    }
  },
  "required": [
    "@id",
    "xdm:timestamp"
  ],
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/identitymap"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/data/time-series"
    },
    {
      "$ref": "#/definitions/experienceevent"
    }
  ],
  "meta:status": "stabilizing"
}