vision

Read-only access to observations produced by a scanner.

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/vision/scanners/{scanner_id}/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/.

scanner_idstring uuid required

Query parameters

backfill_idstring uuid

Only observations dispatched by this backfill.

date_fromstring

Only observations created at or after this time. Accepts ISO 8601, a relative date like -7d, or now; values without an explicit offset are interpreted in the project's timezone.

date_tostring

Only observations created at or before this time. Accepts ISO 8601, a relative date like -1d, or now for the current time; omit it to query through the current time. Date-only values include the whole day, interpreted in the project's timezone.

labeledboolean

When true, return only observations that have a shared label (thumbs up or down); when false, only unlabeled observations.

limitinteger

Number of results to return per page.

max_scorenumber double

Filter scorer observations to those scoring at or below this value. Rows with no numeric score (other scanner types, failed or in-flight runs) are excluded.

min_scorenumber double

Filter scorer observations to those scoring at or above this value. Rows with no numeric score (other scanner types, failed or in-flight runs) are excluded.

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.

recording_subjectstring

Filter to observations whose person email contains this value (case-insensitive).

session_idstring

Filter to observations of one or more session recordings. Accepts a comma-separated list.

statusstring

Filter by observation status. Accepts a comma-separated list.

tagsstring

Filter classifier observations whose fixed or freeform tags include any of the given values (comma-separated). Matches if the tag appears in either tags or tags_freeform.

triggered_bystring

Filter by trigger source (schedule, on_demand, retry, or backfill). Accepts a comma-separated list.

variantstring

Experiment scanners only: filter to observations attributed to any of the given variant keys (comma-separated). __unattributed__ matches observations with no attributed variant.

verdictstring

Filter monitor observations by verdict. Accepts a comma-separated list (e.g. yes,inconclusive).

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.