Skip to main content

List comments

GET https://api.rollstack.com/public/v1/reports/{id}/comments

The comments on a report's slides, oldest first: each thread's first comment, whose threadId is null and which says whether the thread is resolved, then its replies. Read the open threads to see what reviewers asked for. Members who can view the report may.

Requires the slide_decks:read scope.

Operation ID: listReportComments.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.

Response 200

Success

application/json: array of object

  • id (string, required): Unique identifier for the comment. Pass a thread's first comment's id as threadId to reply to it, or to resolveReportComment.
  • threadId (string or null, required): The thread the comment replies to, by its first comment's id. null for the comment that starts a thread.
  • slideId (string, required): The slide the thread is on, as slideId in getReportContent.
  • text (string, required): What the comment says, as plain text: a mention reads as @ and the name, and a request to the Rollstack Agent as @Rollstack.
  • author (object, required): Who wrote it. A reply the Rollstack Agent posted names the member who asked it.
    • id (number, required): The member's user id, the same as their id in listMembers.
    • name (string, required): The member's name, as shown in Rollstack.
  • byAgent (boolean, required): Whether the Rollstack Agent posted it, answering a comment that tagged @Rollstack.
  • createdAt (string (date-time), required): When the comment was posted.
  • resolvedAt (string (date-time) or null, required): When its thread was resolved. Only a thread's first comment has it; null while the thread is open.
  • resolvedBy (object or null, required): Who resolved the thread. null while it is open.
    • id (number, required): The member's user id, the same as their id in listMembers.
    • name (string, required): The member's name, as shown in Rollstack.