Reviews
Get a review
GET /v1/reviews/{id}- Permission
read:reviews- Tokens
- API key, CLI user token, Session token
Read a code review with its reviewers and every comment they returned, including the ones held back for anchoring outside the reviewed range.
Path parameters
idstringrequired
{
"base_sha": str,
"budget": int,
"created_at": str,
"error": str,
"event": str,
"finalized_at": str,
"findings": int,
"github_review_id": int,
"head_sha": str,
"id": str,
"status": str,
}
1
import os
2
3
from ellipsis import Ellipsis
4
5
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
6
7
result = client.reviews.get("...")
8
print(result)
1
import { Ellipsis } from '@ellipsis-dev/sdk';
2
3
const client = new Ellipsis({
4
apiKey: process.env.ELLIPSIS_API_TOKEN!,
5
});
6
7
const result = await client.reviews.get('...');
8
console.log(result);
1
curl "https://api.ellipsis.dev/v1/reviews/{id}" \
2
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"
Response
base_shastringrequired
budgetintegerrequired
The reviewer sessions' spend budgets together, in millicents.
commentsarray<ReviewComment>required
costCostrequired
What the reviewer sessions cost together.
created_atstring, date-timerequired
errorstring
eventenum
The GitHub review event the platform submitted, from the config's output.on_pass or output.on_fail; null until posted.
one of
COMMENTAPPROVEREQUEST_CHANGESfinalized_atstring, date-time
findingsintegerrequired
Comments the reviewers returned, posted to GitHub or not.
github_review_idinteger
The GitHub review id once posted.
head_shastringrequired
The commit the review is anchored at.
idstringrequired
pull_requestReviewPullRequestrequired
repositoryReviewRepositoryrequired
reviewersarray<ReviewReviewer>required
statusenumrequired
running: reviewers are working. posted: one GitHub review was posted. empty: the review passed silently, so nothing was posted. failed: no reviewer finished or GitHub refused the review.
one of
runningpostingpostedemptyfailedtokensTokensrequired
Tokens the reviewer sessions used together.