visual_review

List runs for the team, optionally filtered by review state, PR number, commit SHA, branch, or free-text search.

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

Request

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

branchstring

Filter by branch name

commit_shastring

Filter by full commit SHA

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

pr_numberinteger

Filter by GitHub PR number

review_state'clean' | 'needs_review' | 'processing' | 'stale'

Filter by where the run stands in review. needs_review: a completed pull request run with changes nobody approved yet. clean: no changes, or approved. processing: diffs still computing. stale: superseded by a newer run while its changes were unapproved.

searchstring

Free-text search over branch, commit SHA, run type, and PR number

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

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.