visual_review

Complete a run: detect removals, verify uploads, trigger diff processing.

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

Request

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

check_run_idstring

Numeric GitHub Actions job ID of the CI job that completes the run, from ${{ job.check_run_id }}. Recompute re-runs this job, so it re-reads the verdict without capturing the snapshots again. Omit it outside GitHub Actions.

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.