What the household's browsers reported

client_events

GET/api/v1/households/{household_id}/client-events

Route

The events the web app reported for this household in the last 7 days, newest first: errors, the device database and sync, load times and stuck screens. Personal API tokens can read it.

Parameters#

What the household's browsers reported: parameters
Field	Description
`household_id`pathstringrequired	The household's ID, hh_….
`since`queryinteger or nulloptional	Only events the server got after this time, UTC milliseconds. at least 0
`kind`querystringoptional	Only these kinds, comma-separated, such as error,stall.
`limit`queryintegeroptional	At most this many, 1 to 500. 1 to 500Default `100`

Response#

200 The events, newest first.

What the household's browsers reported: response fields
Field	Description
`items`array of objectsrequired
`items[].id`stringrequired	The event's ID, cev_….
`items[].kind`stringrequired	No description.
`items[].message`stringrequired	No description.
`items[].detail`objectrequired
`items[].source`stringrequired	No description.
`items[].tab_id`stringrequired	No description.
`items[].client_id`string or nullrequired	No description.
`items[].build`stringrequired	No description.
`items[].path`stringrequired	No description.
`items[].user_agent`stringrequired	No description.
`items[].user_id`stringrequired	Whose browser it was, usr_….
`items[].at`string (date-time)required	When it happened, by the browser's clock, UTC.
`items[].received_at`string (date-time)required	When the server got it, UTC.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

What the household's browsers reported: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`403`	Read error.code	Described above.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.

Examples#

No call has been recorded for this operation yet, so this example is built from its schema. The values are placeholders.

Built from the schema

Not recorded from a real call: the fields are filled in from the schema, so the values are placeholders.

Request, curl

curl 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/client-events?since=1&kind=example' \
  -H "Cookie: rigel_session=$RIGEL_SESSION"

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/client-events?since=1&kind=example", {
  headers: {
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
});
const data = await response.json();

Request, HTTP

GET /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/client-events?since=1&kind=example HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9BKNGK0ENW3AHRZ6DMV29GQ

{
  "items": [
    {
      "id": "inv_01K9BKNGK0ENW3AHRZ6DMV29GQ",
      "kind": "example",
      "message": "example",
      "detail": {},
      "source": "example",
      "tab_id": "example",
      "client_id": "cli_01K9BKQB60S07ENW3AHRZ6DMV2",
      "build": "example",
      "path": "example",
      "user_agent": "example",
      "user_id": "usr_01K9BKS5S04BJS07ENW3AHRZ6D",
      "at": "2026-11-06T18:00:00Z",
      "received_at": "2026-11-06T18:00:00Z"
    }
  ]
}