Clusters
Get build
Returns one topic cluster build over the workspace's tickets and scraped web pages, with the clusters, their labels and summaries and the map points behind them, defaulting to the most recent build when no build_id is given.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/clusters
- Authorisation
- Minimum role: USER
Request arguments
| Name |
Type |
Source |
| build_id | Int32 | Query |
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_cluster_build
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_cluster_build
| Name | Type | ReadOnly | Description |
|---|
| clusters | DTO_cluster[] | | Clusters |
| id | Int32 | | Id |
| created | DateTime | | Created |
DTO_cluster
| Name | Type | ReadOnly | Description |
|---|
| map_points | DTO_cluster_map_point[] | | Map points |
| index | Int32 | | Index |
| label_level_1 | String | | Label level 1 |
| label_level_2 | String | | Label level 2 |
| summary | String | | Summary |
| doc_count | Int32 | | Doc count |
| centroid_x | Double | | Centroid x |
| centroid_y | Double | | Centroid y |
DTO_cluster_map_point
| Name | Type | ReadOnly | Description |
|---|
| entity_id | Int32 | | Entity id |
| entity | ENUM entity | | Entity |
| label | String | | Label |
| url | String | | Page url when the entity is a scraped item, otherwise null |
| x | Double | | X |
| y | Double | | Y |
ENUM entity
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | LIST | LIST |
| 2 | GROUP | GROUP |
| 3 | USER | USER |
| 4 | LIST_ENTRY | LIST_ENTRY |
| 5 | TICKET | TICKET |
| 6 | SEARCH | SEARCH |
| 7 | INVOICE | INVOICE |
| 8 | KNOWLEDGE_BASE | KNOWLEDGE_BASE |
| 9 | SCRAPED_ITEM | SCRAPED_ITEM |
| 10 | FIELD | FIELD |
| 11 | TICKET_CONVERSATION | TICKET_CONVERSATION |
| 12 | EXPORT | EXPORT |
| 13 | EXTERNAL_PRODUCT | EXTERNAL_PRODUCT |
| 14 | TEMPLATE | TEMPLATE |
| 15 | PROFILE_API | PROFILE_API |
| 16 | FAQ | FAQ |
Generated Aug 4, 2026 18:37
