UI Events (Dynamic API)

This article provides an example of a UI Events dynamic API query.

Latest version of the UI Events Dictionary, the event log can be accessed via the following Dynamic API endpoint:

/api/v1/search/datastoreUIEvents

This endpoint can be viewed in Swagger.

Example of payload to send in the request:

{
	"filters": [{
			"type": "terms",
			"field": "deliveryId",
			"values": ["76joiiouo999"]
		}],
	"pageSize": "500",
	"sort": [{
			"type": "ASC",
			"field": "timestamp"
		}],
	"pageNumber": "0",
	"response": {
		"flatResponse": false
	}
}

For definitions of fields, see Datastore UI Events.

Logging of Accessibility tool events

Which events are logged?

Accessibility panel opened/closed
Zoom level changed
Contrast theme changed
Mouse pointer changed
Font family changed
Font size changed
Line height changed
Text spacing changed

Format of logged events

The JSON examples below are what is retrieved from the ui-log channel of TAO Insights.

Accessibility panel opened/closed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "custom",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "type": "panel-open"
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  },
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "custom",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "type": "panel-close"
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Zoom level changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "pageZoom",
      "toolState": {
        "value": 125, // value from [100, 110, 125, 150, 175, 200]
        "nonDefault": true // value from [true, false]
      },
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Contrast theme changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "contrastTheme",
      "toolState": {
        "value": "whiteOnBlack", // value from ["default", "blackOnCream", "blackOnMagenta", "blackOnBlue", "yellowOnBlue", "greyOnGreen"]
        "nonDefault": true // value from [true, false]
      },
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Mouse pointer changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "mousePointer",
      "toolState": {
        "size": 128, // value from [16, 32, 64, 96, 128]
        "color": "green", // value from ["default", "white", "black", "yellow", "red", "green"]
        "nonDefault": true // value from [true, false]
      }
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Font family changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "fontFamily",
      "toolState": {
        "value": "courier", // value from ["default", "arial", "verdana", "courier", "cmuserif", "luciole"]
        "nonDefault": true // value from [true, false]
      }
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Font size changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "fontSize",
      "toolState": {
        "value": 1, // value from [0, 1, 2]
        "fontSizeBody": "2.5rem", // value from ["2.5rem", "3.125rem", "3.75rem"]
        "fontSizeDescriptor": "large", // value from ["normal", "large", "extraLarge"]
        "nonDefault": true // value from [true, false]
      }
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Line height changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "lineHeight",
      "toolState": {
        "value": 3, // integer from 0 to 10
        "lineHeightBodyValue": 1.7999999999999998 // float, min: 1.5, max: 2.5
        "nonDefault": true // value from [true, false]
      }
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]

Text spacing changed:

[
  {
    "deliveryExecutionId": "some-id",
    "deliveryId": "5500c66d0973",
    "domEventType": "change",
    "id": "1671178717806961134",
    "itemId": "item1",
    "metadata": {
      "timeStamp": 1704727354129,
      "component": "plugin-a11yMenuPanel",
      "toolKey": "letterAndWordSpacing",
      "toolState": {
        "value": 1, // integer from 0 to 5
        "letterSpacingValue": "0.0625em" //  min: "0.0625em", max: "0.25em"
        "nonDefault": true // value from [true, false]
      }
    },
    "timestamp": "2024-01-08T15:22:34.129Z"
  }
]