visual_review

Mark snapshots reviewed (DB only).

Records the per-snapshot "Accept change" decision. Does not commit the baseline or change the GitHub gate — call finalize to ship the run. Works on a quarantined snapshot too: a quarantined snapshot approved here is committed by finalize, which updates a quarantined story's baseline entry without lifting the quarantine.

post/api/projects/{project_id}/visual_review/runs/{id}/approve/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/visual_review/runs/{id}/approve/
  • 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/.

Request body

Response

purpose'review' | 'observe' required
  • review - review
  • observe - observe
idstring uuid required
repo_idstring uuid required
statusstring required
run_typestring required
commit_shastring required
branchstring required
pr_numberinteger nullable required
approvedboolean required
approved_atstring date-time nullable required
error_messagestring nullable required
created_atstring date-time required
completed_atstring date-time nullable required
is_staleboolean
superseded_by_idstring uuid nullable
metadataobject

Changes

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