Get a PR review

GET

pr-reviews

{prReviewId}

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "user_id": "<string>",
  "provider": "github",
  "installation_id": 123,
  "status": "pending",
  "repository_full_name": "<string>",
  "pr_number": 123,
  "pr_title": "<string>",
  "pr_url": "<string>",
  "head_branch": "<string>",
  "base_branch": "<string>",
  "head_sha": "<string>",
  "base_sha": "<string>",
  "start_sha": "<string>",
  "pr_author": "<string>",
  "trigger": "webhook",
  "mode": "review",
  "pr_state": "open",
  "pr_merged_at": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "verdict": "approve",
  "findings_count": 1,
  "open_findings_count": 1,
  "max_open_score": 123,
  "duration": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "posted_at": "2023-11-07T05:31:56Z",
  "findings": {
    "total": 123,
    "critical": 123,
    "high": 123,
    "medium": 123,
    "low": 123,
    "unresolved": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    },
    "snoozed": 123,
    "fixed": 123
  },
  "vulnerabilities": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "severity": "critical",
      "status": "open",
      "cve": "<string>",
      "cvss": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "target": "<string>",
      "endpoint": "<string>",
      "method": "<string>",
      "code_locations": [
        {}
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

prReviewId

string<uuid>

required

PR review id.

Response

PR review details.

One PR review run plus PR-wide reconciled finding counts in findings.

string<uuid>

required

organization_id

string

required

user_id

string | null

required

provider

enum<string>

required

Available options:

github,

gitlab,

bitbucket

installation_id

integer

required

status

enum<string>

required

Available options:

pending,

running,

completed,

posting,

posted,

failed

repository_full_name

string

required

pr_number

integer

required

pr_title

string | null

required

pr_url

string | null

required

head_branch

string

required

Source branch reviewed by this run.

base_branch

string | null

required

Destination branch for the pull request. Null when the provider did not supply it.

head_sha

string

required

base_sha

string | null

required

start_sha

string | null

required

pr_author

string | null

required

trigger

enum<string>

required

Available options:

webhook,

manual

mode

enum<string> | null

required

Available options:

review,

verify_base,

null

pr_state

enum<string> | null

required

The pull request's own lifecycle, stamped when a review starts and kept live by provider webhooks. Null on older reviews.

Available options:

open,

merged,

closed,

null

pr_merged_at

string<date-time> | null

required

summary

string | null

required

verdict

enum<string> | null

required

Available options:

approve,

comment,

request_changes,

null

findings_count

integer

required

Trigger-maintained count for this individual review run. Prefer the nested findings.total field for the PR-wide aggregate shown by list and detail views.

Required range: x >= 0

open_findings_count

integer

required

Trigger-maintained unresolved count for this individual review run. Prefer nested findings.unresolved.total for the PR-wide actionable aggregate.

Required range: x >= 0

max_open_score

number | null

required

duration

string | null

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

posted_at

string<date-time> | null

required

findings

object

required

PR-wide finding counts used by list and detail views. They combine the selected/latest run's reconciled findings with deduplicated fixed findings from earlier runs of the same pull request. The top-level severity totals cover that aggregate; unresolved covers findings still open or in progress, snoozed counts deliberately deferred findings, and fixed includes fixed history across runs.

Show child attributes

vulnerabilities

object[]

required

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "user_id": "<string>",
  "provider": "github",
  "installation_id": 123,
  "status": "pending",
  "repository_full_name": "<string>",
  "pr_number": 123,
  "pr_title": "<string>",
  "pr_url": "<string>",
  "head_branch": "<string>",
  "base_branch": "<string>",
  "head_sha": "<string>",
  "base_sha": "<string>",
  "start_sha": "<string>",
  "pr_author": "<string>",
  "trigger": "webhook",
  "mode": "review",
  "pr_state": "open",
  "pr_merged_at": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "verdict": "approve",
  "findings_count": 1,
  "open_findings_count": 1,
  "max_open_score": 123,
  "duration": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "posted_at": "2023-11-07T05:31:56Z",
  "findings": {
    "total": 123,
    "critical": 123,
    "high": 123,
    "medium": 123,
    "low": 123,
    "unresolved": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    },
    "snoozed": 123,
    "fixed": 123
  },
  "vulnerabilities": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "severity": "critical",
      "status": "open",
      "cve": "<string>",
      "cvss": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "target": "<string>",
      "endpoint": "<string>",
      "method": "<string>",
      "code_locations": [
        {}
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

LLM

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

License

Supply Chain

CLI

Billing

Workspaces

Get a PR review

Authorizations

Path Parameters

Response