Skip to main content

Comments

What reviewers say about a report's slides, as in its comments in the app. A comment starts a thread on a slide, and replies follow it until someone resolves the thread.

Read the comments with listReportComments, make the changes they ask for, for example by asking the slides agent in Chat, then reply with createReportComment and resolve the thread with resolveReportComment.

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.

Add comment

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

Starts a comment thread on a slide of a report, or replies to a thread, as the user. A reply notifies the thread's other participants who can still open the report. Members who can comment on the report may.

Requires the slide_decks:write scope.

Operation ID: createReportComment.

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/.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body, required

application/json

  • text (string, required): The comment, as plain text: each line becomes a paragraph, and Markdown marks such as ** and # are removed. Mentions and @Rollstack requests can only be written in the app. At most 5000 characters. Example: Updated the EMEA numbers on this slide..
  • slideId (string): The slide to start a new thread on, as slideId in getReportContent. Leave it out with threadId.
  • threadId (string): The thread to reply to, by its first comment's id from listReportComments. The reply goes on the thread's slide, and the thread's other participants are notified.

Response 201

Success

application/json

  • 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.

Resolve comment thread

POST https://api.rollstack.com/public/v1/reports/{id}/comments/{commentId}/resolve

Resolves a comment thread once what it asked for is done, or opens it again, as the user. Only a thread's first comment can be resolved. Members who can comment on the report may.

Requires the slide_decks:write scope.

Operation ID: resolveReportComment.

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/.
  • commentId (string, required): The thread to act on, by its first comment's id from listReportComments, the one whose threadId is null.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body, required

application/json

  • resolved (boolean): true to resolve the thread, false to open it again. Defaults to true.

Response 200

Success

application/json

  • 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.