visual_review

Get a run's snapshots with diff results, excluding quarantined ones by default.

get/api/projects/{project_id}/visual_review/runs/{id}/snapshots/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/visual_review/runs/{id}/snapshots/
  • Auth: HTTP bearer

Path parameters

idstring required
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

exclude_unchangedboolean

Whether to leave out snapshots whose result is unchanged. Defaults to false. Pass true to list only the changed, new and removed snapshots, which is what a review needs. A large run holds thousands of unchanged snapshots and few changes.

include_quarantinedboolean

Whether to include snapshots whose identifier is currently quarantined. Defaults to false: quarantined snapshots are excluded from results and reported in quarantined_count instead, since they are noise when reviewing real changes. This filter uses the quarantines active now. Each snapshot's is_quarantined flag holds the state when the run was gated, so for an older run pass true and read the flag.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

quarantined_onlyboolean

Whether to list only the snapshots whose identifier is currently quarantined. Defaults to false. When true, include_quarantined is ignored and quarantined snapshots are returned. Combine with exclude_unchanged=false to find a quarantined story that rendered unchanged, which is the snapshot to request a lift on merge for. This uses the quarantines active now, not each snapshot's is_quarantined flag, so on an older run it misses stories whose quarantine has ended since.

snapshot_idstring uuid

Return only the snapshot with this id, read from the id field of a snapshot in the run. Use it to fetch one snapshot without listing the whole run.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable
quarantined_countinteger

Count of this run's snapshots that match the other filters and whose identifier is quarantined now. Excluded from results unless include_quarantined=true is passed. This can differ from the run's own counts, which use the quarantines at gating time.

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.