reviews

Export completed reviews

Changed on
get/api/export/reviews

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

formatstring

Output format; only json is supported

profilestring

Export profile: content or metadata

sincestring

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)

closed_onlyboolean

Only include reviews marked closed

updated_sincestring

Inclusive updated_at lower bound (RFC3339 or YYYY-MM-DD). A filter that combines with since, until, cursor, and the other filters; ordering stays on completed_at.

repostring

Exact exported repo identifier filter

projectstring

Exact project display-name filter

limitinteger

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.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

database_idstring uuid 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

  • 04e4cb796661Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

  • b22d3419baf1Revision changes
    • info

      added the new optional query request parameter updated_since

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property // to the response with the status