Reports

A report version's review tips

Changed on

Report review (spec 2026-10-06 §12). The latest wording run, the counts and every tip of one version, in document order (completeness and wording interleaved; the client groups them). Completeness tips are derived from the frozen version on every read, and a row is stored only when one is applied or dismissed, so a GET never writes. Wording tips are stored by a run and carry state (current or out_of_date, recomputed on every read) and, when current, the sentence's UTF-16 span. Template issues are never returned. 404 while REPORT_REVIEW_ENABLED or REPORTS_V2_ENABLED is off, for a report the request cannot reach, and for a version of another report; 409 REPORT_NOT_REVIEWABLE for an earlier builder's version. Needs report.edit_draft.

get/reports/{id}/versions/{versionId}/review

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/reports/{id}/versions/{versionId}/review
  • Auth: HTTP bearer

Path parameters

idstring required
versionIdstring required

Response

The version's review

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

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

    • info

      added the optional 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