reviews

Export finalized CI panel metrics

Changed on
get/api/export/ci-metrics

Request

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

Query parameters

formatstring

Output format; only json is supported

sincestring

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

untilstring

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

limitinteger

Maximum panels in this page

cursorstring

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

legacyboolean

Export the frozen pre-panel ci_pr_reviews era instead of panel runs. Cursors are namespaced to this mode and cannot be reused across modes.

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 panels is non-empty.

schema_versioninteger required
toolstring required
tool_versionstring required
truncatedboolean required

True when more matching rows are available immediately.

Example response

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

Changes

  • 4ea02d295259Revision changes
    • breaking

      the //// response's property format changed from no format to uuid for status

  • 9fc133457d16Revision changes
    • info

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

    • info

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