Skip to main content

SessionEventRequest

Body for POST /session/event. The event is validated. Unknown top-level keys are permitted and passed through.

eventstringrequired

The event being reported. Currently, only test is accepted; anything else is rejected with invalidParameter (code 15), and omitting it entirely gives missingParameter (code 16).

Possible values: [test]

parameters objectrequired

The detail the event carries. Required, and its contents are fixed by event: the test event takes a boolean test. Keys beyond the ones the event names are left alone rather than rejected.

testbooleanrequired

The test event's only parameter. Must be a boolean; the string "true" is rejected with invalidParameter (code 15).

property name*any

The detail the event carries. Required, and its contents are fixed by event: the test event takes a boolean test. Keys beyond the ones the event names are left alone rather than rejected.

client_idstring

The client uuid the event belongs to. Required, but may instead arrive as a cid cookie or a client_id query parameter — see Identifying a client. Values longer than 23 characters are silently truncated.

Possible values: <= 23 characters

property name*any

Body for POST /session/event. The event is validated. Unknown top-level keys are permitted and passed through.

SessionEventRequest
{
  "event": "test",
  "parameters": {
    "test": true
  },
  "client_id": "string"
}