comments

Create a comment thread or reply.

Creates a new top-level thread (optionally anchored to a page, or a page + element) or, with parentId set, a reply to an existing top-level thread. The author fields (authorId, actorType) are always taken from the authenticated caller — never from the request body. Requires dashboard read-level access on this dashboard (any viewer may comment) plus the comment:write capability.

post/v1/dashboards/{id}/comments

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/comments
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

bodystring required

Non-empty after trimming whitespace.

pageIdstring

Anchors a new top-level thread to this page — its UUID or its slug. Must be a live page of this dashboard. Omit for an unanchored thread, or when parentId is set (a reply inherits its parent's anchor).

elementIdstring

Anchors a new top-level thread to this element within pageId — its UUID or its slug. Requires pageId. Must resolve to a live element on that page.

parentIdstring uuid

Makes this a reply to the named top-level thread. Mutually exclusive with pageId/elementId (a reply inherits its parent's anchor). The parent must be a live top-level comment in this dashboard — a missing, cross-tenant, or reply parentId is rejected with 400.

Response

Comment created.

Changes

No recorded changes to this operation across all 1 revision of this API.