vision

A session's observations across every scanner the caller can read, plus the team-level semantic search action, which resolves its own scanner scope instead of this queryset.

get/api/projects/{project_id}/vision/observations/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/vision/observations/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

order_by'-completed_at' | '-created_at' | '-label' | '-recording_subject_email' | '-result_confidence' | '-result_score' | '-result_verdict' | '-scanner_version' | '-started_at' | '-status' | 'completed_at' | 'created_at' | 'label' | 'recording_subject_email' | 'result_confidence' | 'result_score' | 'result_verdict' | 'scanner_version' | 'started_at' | 'status'

Sort observations. Plain keys: created_at, started_at, completed_at, status, recording_subject_email. JSONB keys: result_score (scorer), result_verdict (monitor), result_confidence, scanner_version. Prefix with - for descending; nullable keys sort nulls last either way.

session_idstring required

Session recording id to return observations for.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.