DOdovetail
Insights

List insights

Changed on

Retrieve all insights in your workspace. Insights are polished research deliverables — written reports that synthesize findings from data entries, highlights, and other sources into actionable recommendations. They can be shared with stakeholders.

Note: The insights resource is deprecated. New integrations should use docs (/v1/docs) instead, which provide the same functionality. Existing insight endpoints continue to work but responses include a Deprecation header.

Results can be filtered by folder, project, title, or creation date. They can be sorted by creation date or title and are paginated.

Required scope: insight:read

get/v1/insights

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/insights
  • Auth
    HTTP bearer

Query parameters

start_cursorstring
limitinteger nullable

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

See Filters for details on parameter formatting.

'created_at:asc' | 'created_at:desc' | 'title:asc' | 'title:desc'
OR
string[]

See Sort for details on the sort parameter.

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