Reviews
Get a review
Read findings, stage results, coverage, and cost for a review.
TypeScript SDKThe npm client, generated from the API spec.Python SDKThe PyPI client, sync and async.
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/reviews/{review_id} | read:reviews |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Path parameters
review_idstringrequired
curl "https://api.ellipsis.dev/v1/reviews/{review_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.reviews.get("review_example")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.reviews.get("review_example");
console.log(result);Request
Response
Example response, 200
{
"budget_millicents": 0,
"completed_at": "string",
"cost_millicents": 0,
"created_at": "string",
"description_error": "string",
"description_outcome": "string",
"findings": [],
"id": "string",
"post": true,
"post_error": "string",
"posted_review_id": 0,
"review_body": "string",
"reviewed_commits": [],
"skip_reason": "string",
"stages": [],
"status": "string",
"trigger": "string"
}