DOdovetail
Channels

List channel themes

Changed on

Retrieve all themes for a channel. Themes are AI-generated clusters of data points that share a common subject within a topic. Each theme has a title (a short label summarising the cluster), an optional summary (a longer AI-generated description of what data points in the theme share in common), and a datum_count (the number of data points currently classified into the theme).

Results are sorted by datum_count:desc by default and are paginated using cursor-based pagination.

🚧 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: channel:read

get/v1/channels/{channel_id}/themes

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/channels/{channel_id}/themes
  • Auth
    HTTP bearer

Path parameters

channel_idstring required

Unique identifier of the channel.

Query parameters

start_cursorstring
limitinteger nullable

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

'datum_count:asc' | 'datum_count:desc' | 'created_at:asc' | 'created_at: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