vision

CRUD for Replay Vision scanners.

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

Request

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

created_bystring

Filter to scanners created by the given user IDs (comma-separated).

emits_signalsboolean

Filter to scanners that emit Signals.

enabledstring

Filter by enabled state. Accepts enabled, disabled, a comma-separated list of both, or the boolean form true/false. Omit to list every scanner.

experiment_idstring

Filter to scanners whose targeting watches the given experiment.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

order_by'-created_at' | '-created_by' | '-credits_this_month' | '-enabled' | '-name' | '-sampling_rate' | '-scanner_type' | '-updated_at' | 'created_at' | 'created_by' | 'credits_this_month' | 'enabled' | 'name' | 'sampling_rate' | 'scanner_type' | 'updated_at'

Sort scanners by name, created_at, updated_at, scanner_type, enabled, sampling_rate, created_by, credits_this_month. Prefix with - for descending.

scanner_typestring

Filter by scanner type (monitor, classifier, scorer, summarizer). Accepts a comma-separated list.

searchstring

Case-insensitive substring match across name, description, and the prompt in scanner_config.

tagsstring

Filter to scanners carrying at least one of the given tags (comma-separated).

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.