Sign in
reviews

Export completed reviews

get/api/export/reviews

Query parameters

formatstring

Output format; only json is supported

Output format; only json is supported

profilestring

Export profile: content or metadata

Export profile: content or metadata

sincestring

Inclusive completed_at lower bound (RFC3339 or YYYY-MM-DD)

Inclusive completed_at lower bound (RFC3339 or YYYY-MM-DD)

untilstring

Exclusive completed_at upper bound (RFC3339 or YYYY-MM-DD; date-only means through that UTC day)

Exclusive completed_at upper bound (RFC3339 or YYYY-MM-DD; date-only means through that UTC day)

closed_onlyboolean

Only include reviews marked closed

Only include reviews marked closed

repostring

Exact exported repo identifier filter

Exact exported repo identifier filter

projectstring

Exact project display-name filter

Exact project display-name filter

limitinteger

Maximum top-level reviews in this page

Maximum top-level reviews in this page

cursorstring

Opaque next_cursor from a previous page. Resumes strictly after its (completed_at, review_id) position; mutually exclusive with since.

Opaque next_cursor from a previous page. Resumes strictly after its (completed_at, review_id) position; mutually exclusive with since.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

database_idstring required

Stable identity for the local review database; changes when the database is recreated.

generated_atstring required
next_cursorstring nullable required

Opaque resume cursor emitted when reviews is non-empty; pass as cursor to resume after the last returned review.

profilestring required
schema_versioninteger required
toolstring required
tool_versionstring required
truncatedboolean required

True when more matching rows are available immediately.

Example response

{
  "$schema": "https://example.com/ExportReviewsDocument.json"
}

Changes

Changed in 4 of the 23 revisions of this API.16

  • 9fc133457d163See the full diff
    • ○

      added the required property reviews/items/experiments to the response with the 200 status

      response-required-property-added

    • ○

      added the required property reviews/items/resume_source_job_uuid to the response with the 200 status

      response-required-property-added

    • ○

      added the required property reviews/items/subagents/items/resume_source_job_uuid to the response with the 200 status

      response-required-property-added

  • 39eeb10f396e2See the full diff
    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the required property database_id to the response with the 200 status

      response-required-property-added

  • e7bbb5e4c9a41See the full diff
    • ○

      endpoint added

      endpoint-added

  • 538b457f849b1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog