review_hog

Look up a pull request's review status

Where a pull request's review runs stand: state, the latest completed review turn, and the latest Resolve run. Works for any pull request on the project, also ones the caller did not trigger. Pass the requested_at and head_sha the trigger returned, and the run_mode it was called with, to get request_outcome, which says when that request is done.

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

Request

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

head_shastring

The head_sha the trigger returned. Lets a turn that was already running on that head when the request came in answer the request. Only used with requested_at.

pr_urlstring required

GitHub pull request URL to look up, e.g. 'https://github.com/PostHog/posthog/pull/123'.

requested_atstring date-time

The requested_at the trigger returned. When set, the response carries request_outcome for that request.

run_mode'review' | 'review_only' | 'resolve_only' | 'flash'

The run_mode the trigger was called with (default 'review'). Only used with requested_at.

  • review - Review
  • review_only - Review only
  • resolve_only - Resolve only
  • flash - Standard

Response

The pull request's review status.

repositorystring required

The pull request's repository as 'owner/repo'.

pr_numberinteger required

The pull request number.

report_idstring uuid nullable required

The PR's review id, for review-hog-reviews-get; null before its first run.

state'not_reviewed' | 'queued' | 'reviewing' | 'resolving' | 'idle' | 'unknown' required
  • not_reviewed - Not reviewed
  • queued - Queued
  • reviewing - Reviewing
  • resolving - Resolving
  • idle - Idle
  • unknown - Unknown

Changes

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