work.lexical.action Documentation (EN)

main record

A record representing an action taken on a creative work.

Record Key tid Timestamp-based ID

Properties

actionType string Required

The type of action performed.

maxLength: 64 bytesmaxGraphemes: 64 graphemes

Known values: watch, read, listen, play

occurredAt string datetime Optional

When the action occurred.

maxLength: 64 bytes

work string at-uri Required

AT URI of the work this action was performed on.

maxLength: 2048 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "work",
      "actionType"
    ],
    "properties": {
      "work": {
        "type": "string",
        "format": "at-uri",
        "required": true,
        "maxLength": 2048,
        "description": "AT URI of the work this action was performed on."
      },
      "actionType": {
        "type": "string",
        "required": true,
        "maxLength": 64,
        "description": "The type of action performed.",
        "knownValues": [
          "watch",
          "read",
          "listen",
          "play"
        ],
        "maxGraphemes": 64
      },
      "occurredAt": {
        "type": "string",
        "format": "datetime",
        "maxLength": 64,
        "description": "When the action occurred."
      }
    }
  },
  "description": "A record representing an action taken on a creative work."
}