List Observations

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

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list"

payload = { "filters": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({filters: {}})
};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/observations/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list"

	payload := strings.NewReader("{\n  \"filters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8000/v2/workspaces/{workspace_id}/observations/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/observations/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

workspaces

{workspace_id}

observations

list

List Observations

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

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list"

payload = { "filters": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({filters: {}})
};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/observations/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/observations/list"

	payload := strings.NewReader("{\n  \"filters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8000/v2/workspaces/{workspace_id}/observations/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/observations/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 | null

Response

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

API Documentation

workspaces

peers

sessions

messages

observations

webhooks

miscellaneous

List Observations

Authorizations

Path Parameters

Query Parameters

Body

Response