---
title: "Read per-reviewer progress for a PR, branch document, or draft review."
method: GET
path: "/api/v1/review/progress"
tags: ["Review progress"]
---

# Read per-reviewer progress for a PR, branch document, or draft review.

`GET /api/v1/review/progress`

## Request

- Base URL: `https://commentary.dev`
- URL: `https://commentary.dev/api/v1/review/progress`
- Auth: HTTP bearer

Agents can read progress but cannot mutate human review progress through the external API.

## Query parameters

- `provider` 'github'
- `owner` string
- `repo` string
- `draftSessionId` string
- `file` string[]
- `pr` integer
- `branch` string
- `revision` string

## Headers

- `X-Commentary-Workspace-Id` string
- `X-Correlation-Id` string

## Response `200`

Successful response.

- ReviewProgressResponse
  - `ok` unknown, required
  - `viewerScoped` boolean, required
  - `summary` ReviewProgressSummary, required
    - `totalFiles` integer
    - `reviewedFiles` integer
    - `inProgressFiles` integer
    - `skippedFiles` integer
    - `needsReReviewFiles` integer
    - `notStartedFiles` integer
    - `changedSinceReviewedFiles` integer
    - `percentReviewed` integer
    - `lastReviewedFilePath` string, nullable
    - `lastReviewedSectionTitle` string, nullable
  - `files` ReviewProgressFile[], required
    - `filePath` string, required
    - `status` 'not_started' | 'in_progress' | 'reviewed' | 'needs_re_review' | 'skipped', required
    - `reviewedAt` string, date-time, nullable
    - `reviewedByViewerId` string, nullable
    - `reviewedByLogin` string, nullable
    - `lastInteractedAt` string, date-time, nullable
    - `reviewedRevision` string, nullable
    - `currentRevision` string, nullable
    - `changedSinceReviewed` boolean, required
    - `skippedReason` string, nullable
    - `partial` object, nullable

## Other responses

- `400`: The request was invalid.
- `401`: Authentication is required.
- `403`: The token or session does not have permission for this resource.
- `404`: The resource was not found.
- `429`: The request was rate limited.

---

[API](https://skmtc.dev/commentary/apis/commentary-public-api.md) · [All operations](https://skmtc.dev/commentary/apis/commentary-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commentary/apis/commentary-public-api/revisions/7aaafc198c52?raw)