prototype-event-schema/event.json at master · marvelapp/prototype-event-schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://example.com/root.json",
  "type": "object",
  "title": "The Root Schema",
  "required": [
    "trigger",
    "object",
    "outcome",
    "id",
    "prevId",
    "timestamp"
  ],
  "properties": {
    "trigger": {
      "$id": "#/properties/trigger",
      "type": "object",
      "title": "The Trigger Schema",
      "description": "What caused the event to happen, such as user interaction or an elapsed timer",
      "required": [
        "type"
      ],
      "properties": {
        "externalId": {
          "$id": "#/properties/trigger/properties/externalId",
          "type": "string",
          "title": "The Externalid Schema",
          "description": "The external ID of the trigger, such as the name of a button or the ID of a Figma node that was clicked",
          "examples": [
            "button1",
            "874:123"
          ]
        },
        "type": {
          "$id": "#/properties/trigger/properties/type",
          "type": "string",
          "enum": [
            "doubletap",
            "tap",
            "mousemove",
            "pinch",
            "swipe",
            "timer",
            "user",
            "player",
            "navigation"
          ],
          "title": "The Type Schema",
          "examples": [
            "tap"
          ],
          "pattern": "^(.*)$"
        }
      }
    },
    "object": {
      "$id": "#/properties/object",
      "type": "object",
      "title": "The Object Schema",
      "description": "The object that was used in triggering this event, such as a hotspot or a screen",
      "default": null,
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$id": "#/properties/object/properties/type",
          "type": "string",
          "enum": [
            "screen",
            "hotspot",
            "overlay",
            "player",
            "scrollContainer"
          ],
          "title": "The Type Schema",
          "examples": [
            "screen"
          ],
          "pattern": "^(.*)$"
        }
      }
    },
    "outcome": {
      "$id": "#/properties/outcome",
      "type": "object",
      "title": "The Outcome Schema",
      "description": "An action that has happened as a result of this event occuring",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$id": "#/properties/outcome/properties/type",
          "type": "string",
          "enum": [
            "miss",
            "openUrl",
            "screenTransition",
            "overlayTransition",
            "removeOverlay",
            "scroll",
            "resize",
            "startRecording",
            "stopRecording",
            "goalReached"
          ],
          "title": "The Type Schema",
          "examples": [
            ""
          ],
          "pattern": "^(.*)$"
        }
      }
    },
    "id": {
      "$id": "#/properties/id",
      "type": "string",
      "title": "The id Schema",
      "description": "Globally unique ID for the test",
      "examples": [
        "5065676496486300719"
      ]
    },
    "prevId": {
      "$id": "#/properties/prevId",
      "type": [
        "string",
        "null"
      ],
      "title": "The prevId Schema",
      "description": "Globally unique ID of the previous event",
      "examples": [
        "5065676496485360659"
      ]
    },
    "timestamp": {
      "$id": "#/properties/timestamp",
      "type": "integer",
      "title": "The Timestamp Schema",
      "description": "Timestamp of the event relative to the start of the prototype-viewer session, in ms",
      "examples": [
        650
      ],
      "minimum": 0
    }
  }
}