visual_review

Mark a changed snapshot as a known tolerated alternate.

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

Request

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

snapshot_idstring uuid required

UUID of the changed snapshot to mark as a known tolerated alternate. Future runs that produce the same alternate hash for this identifier will not be flagged as changes.

Response

is_quarantinedboolean

Whether a quarantine covered this snapshot when the run was last gated, so its diff did not block the pull request. It keeps that value after the quarantine ends or a new one starts.

idstring uuid required
run_idstring uuid required
identifierstring required
resultstring required
classification_reasonstring required
diff_percentagenumber double nullable required
diff_pixel_countinteger nullable required
review_statestring required
reviewed_atstring date-time nullable required
approved_hashstring required
tolerated_hash_idstring uuid nullable
metadataobject
ssim_scorenumber double nullable
change_kindstring
size_mismatchboolean

Changes

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