vision

Succeeded observations in the window worth watching, ranked — feeds the What to watch tab.

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

Request

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

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. The window between date_from and date_to may span at most 90 days.

date_tostring

Only observations created at or before this time. Same formats as date_from; omit it to query through the current time.

limitinteger

Ceiling on feed items to return, at most 50. The feed is bounded, not paginated, and routinely returns far fewer: a window is not padded to this number with clips that carry no finding.

scanner_idsstring

Comma-separated scanner UUIDs to restrict the feed to. Defaults to every scanner you can read.

scanner_type'monitor' | 'classifier' | 'scorer' | 'summarizer' | 'experiment'

Restrict the feed to observations from scanners of this type.

  • monitor - Monitor
  • classifier - Classifier
  • scorer - Scorer
  • summarizer - Summarizer
  • experiment - Experiment
searchstring

Case-insensitive text to match against the scan's own words (title, summary, reasoning, and the notability sentence) and the scanner's name. Applied before ranking, so it searches the whole window rather than the items that would have surfaced without it.

tagsstring

Comma-separated scanner tags to restrict the feed to. A team with many scanners uses these to follow one area without naming every scanner in it.

Response

ranker'weighted-score' | 'jev' required
  • weighted-score - weighted-score
  • jev - jev
ranker_variantstring nullable required

The team's variant of the vision-watch-feed-ranker experiment flag (control, jev-shadow, jev), or null when the team takes no part. Unlike ranker, it tells the shadow arm from control. Clients report it on the feed-viewed event as $feature/vision-watch-feed-ranker, which is the exposure the experiment counts.

Changes

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