review_hog

Retrieve one review's detail

One completed code review on this project, with one turn's validated findings, the findings the validator dismissed (and why), and the review body published to GitHub. The latest completed turn by default; run_index reads an older one. in_progress, progress, and the resolution fields describe the report now, whatever the turn. Project-wide, so reviews listed under scope=everyone can be opened too.

get/api/projects/{project_id}/review_hog/reviews/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/review_hog/reviews/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this review report.

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

run_indexinteger

The completed review turn to read, from 1 to run_count. Defaults to the latest completed turn. Use it to read an older turn's findings.

Response

The review's detail: findings (valid and dismissed) and the published body.

idstring uuid required

The review report's id, for fetching the review's detail.

repositorystring required

The reviewed repository, as owner/repo.

pr_numberinteger nullable required

The reviewed pull request's number; null for a branch target with no PR yet.

pr_titlestring nullable required

The pull request's title, from the latest reviewed snapshot; null if unknown.

pr_authorstring nullable required

The pull request author's GitHub login; null if unknown.

additionsinteger nullable required

Lines added by the PR; null if unknown.

deletionsinteger nullable required

Lines deleted by the PR; null if unknown.

changed_filesinteger nullable required

Files the PR changes; null if unknown.

head_branchstring required

The pull request's head branch.

github_urlstring required

Where to see the review on GitHub: the pull request when its URL is known, otherwise the head branch.

run_countinteger required

How many review turns have completed on this report.

last_run_atstring date-time nullable required

When the latest review turn completed; null while the first is in flight.

publishedboolean required

Whether any turn of this report has been published back to GitHub. See turn_published for the returned turn.

turn_publishedboolean required

Whether the returned turn (the latest completed one, or run_index on the detail) was published to GitHub. False when it found nothing to post or publishing was off.

status_comment_urlstring nullable required

Link to the review's status comment on the pull request; null when there is no status comment or no pull request URL.

full_review_publishedboolean required

Whether a Deep review of this pull request has been published. No Standard review runs after one.

in_progressboolean required

Whether a run is on this report right now: a review turn or a resolution run (activity within the last 30 minutes).

must_fix_countinteger required

The latest turn's valid findings at must_fix effective priority.

should_fix_countinteger required

The latest turn's valid findings at should_fix effective priority.

consider_countinteger required

The latest turn's valid findings at consider effective priority.

candidate_countinteger required

All findings the latest turn raised after dedupe, before validation.

dismissed_countinteger required

The latest turn's findings the validator dismissed as not worth publishing.

files_reviewedinteger nullable required

Meaningful files the latest turn actually read, after skipping generated/lock/snapshot files; null if unknown.

chunk_countinteger nullable required

Reviewable chunks the latest turn split the PR into; null if unknown.

perspective_countinteger nullable required

Review perspectives that read each chunk in the latest turn; null if unknown.

perspective_issue_countinteger nullable required

Raw issues the perspectives raised in the latest turn, before dedupe; null if unknown.

blind_spot_issue_countinteger nullable required

Raw issues the blind-spot sweep added in the latest turn, before dedupe; null if unknown.

run_indexinteger required

The review turn this detail describes, from 1 to run_count.

head_shastring nullable required

The PR head commit the returned turn reviewed. Anchors GitHub links to the exact code. Null for an older turn whose head was not recorded.

report_markdownstring nullable required

The rendered review body published to GitHub, as markdown. Only kept for the latest turn, so null when run_index selects an older turn.

Changes

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