DOdovetail
InsightComments

List insight comments

Changed on

Get a list of page-level and inline comments on an insight.

Pass ?include_text_range=true to include the selected text and surrounding context for inline comments. By default the list returns comment text only.

Comments are returned in chronological order by default. Only published comments are included.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: comment:read

get/v1/insights/{insight_id}/comments

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/insights/{insight_id}/comments
  • Auth
    HTTP bearer

Path parameters

insight_idstring required

Unique identifier of the insight.

Query parameters

start_cursorstring
limitinteger nullable

See Pagination for details about how to use a cursor to iterate through the list.

sort'created_at:asc' | 'created_at:desc'

See Sort for details on the sort parameter.

include_text_range'true' | 'false'

When true, inline comments include text_range with the selected text and surrounding context. Defaults to false.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter include_text_range

    • 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