Ellipsis APIReferenceReviews

List Reviews

List the customer's code reviews, newest first, with `findings` omitted (counters only). Webhook-created reviews appear here too, so this answers "show me every review on this PR".

GET
/v1/reviews

List the customer's code reviews, newest first, with findings omitted (counters only).

Webhook-created reviews appear here too, so this answers "show me every review on this PR".

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Query Parameters

owner?string|null
repo?string|null
pull_request_number?integer|null
status?|null
limit?Limit
Range1 <= value <= 200
Default50

Header Parameters

user-agent?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/reviews"
{  "reviews": [    {      "budget_millicents": 0,      "completed_at": "string",      "configuration": {        "config_id": "string",        "effective_yaml": "string",        "raw_yaml": "string"      },      "cost_millicents": 0,      "counters": {        "n_anchor_valid": 0,        "n_coerced": 0,        "n_dropped": 0,        "n_not_commentable": 0,        "n_parsed": 0,        "n_raw_lines": 0,        "n_snapped": 0,        "parser_version": "string"      },      "created_at": "string",      "description_error": "string",      "description_outcome": "string",      "findings": [],      "id": "string",      "post": true,      "post_error": "string",      "posted_review_id": 0,      "pull_request": {        "number": 0,        "url": "string"      },      "repository": {        "id": 0,        "name": "string",        "owner": "string"      },      "requested_by": {        "attribution_id": "string",        "attribution_type": "string"      },      "review_body": "string",      "reviewed_commits": [],      "scope": {        "empty": true,        "head": "string",        "kind": "incremental",        "watermark": "string"      },      "skip_reason": "string",      "stages": [],      "status": "string",      "trigger": "string"    }  ]}

Introduction

Reviews endpoints of the Ellipsis REST API.

Create Review

Run a code review on demand, on an existing PR or on a pushed branch (for a branch, the platform finds or creates a draft PR for it, since a code review is structurally about a PR). A review is one pipeline run over one commit range, with one agent session per stage: `review.id` is the run id, and `stages[].session_id` is where a client streams (/v1/sessions/{id}/stream on a stage session), since the review itself is a pipeline rather than one process.