List Observations

List all observations using custom filters. Observations are listed by recency unless reverse is set to true.

Observations can be filtered by session_id, observer_id and observed_id using the filters parameter.

POST /v2/workspaces/{workspace_id}/observations/list

List Observations

cURL

curl --request POST \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/observations/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {}
}'

200

{
  "items": [
    {
      "id": "<string>",
      "content": "<string>",
      "observer_id": "<string>",
      "observed_id": "<string>",
      "session_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 2,
  "size": 2,
  "total": 1,
  "pages": 1
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id · string · required

ID of the workspace

Query Parameters

reverse · boolean | null · default: false

Whether to reverse the order of results

page · integer · default: 1

Page number

Required range: x >= 1

size · integer · default: 50

Page size

Required range: 1 <= x <= 100

Body

application/json

Schema for listing observations with optional filters

filters · Filters · object

Response

200

application/json

Successful Response

items · Observation · object[] · required

Show child attributes

page · integer | null · required

Required range: x >= 1

size · integer | null · required

Required range: x >= 1

total · integer | null

Required range: x >= 0

pages · integer | null

Required range: x >= 0