---
title: "Returns data for visualizing the documents of the given aspect."
method: POST
path: "/perspectives/visualize_documents/{aspect_id}"
tags: ["perspectives"]
---

# Returns data for visualizing the documents of the given aspect.

`POST /perspectives/visualize_documents/{aspect_id}`

## Path parameters

- `aspect_id` integer, required

## Query parameters

- `search_query` string, required

## Request body

- BodyPerspectivesVisualizeDocuments
  - `filter` FilterSdocColumnsInput, required
    - `id` string, required — Unique id of this node within the filter tree
    - `items` union[], required — Child expressions and/or nested filter nodes
      - union
        - FilterExpressionSdocColumns
          - `id` string, required — Unique id of this expression within the filter tree
          - `column` union, required — The column to filter on: an enum member, or an int id referring to a project-metadata column
            - 'SD_SOURCE_DOCUMENT_TYPE' | 'SD_SOURCE_DOCUMENT_NAME' | 'SD_TAG_ID_LIST_RECURSIVE' | 'SD_CODE_ID_LIST_RECURSIVE' | 'SD_FOLDER_ID_LIST_RECURSIVE' | 'SD_USER_ID_LIST' | 'SD_SPAN_ANNOTATIONS'
            - integer
          - `operator` union, required — The comparison operator applied to the column
            - 'ID_EQUALS' | 'ID_NOT_EQUALS'
            - 'NUMBER_EQUALS' | 'NUMBER_NOT_EQUALS' | 'NUMBER_GT' | 'NUMBER_LT' | 'NUMBER_GTE' | 'NUMBER_LTE'
            - 'STRING_CONTAINS' | 'STRING_EQUALS' | 'STRING_NOT_EQUALS' | 'STRING_STARTS_WITH' | 'STRING_ENDS_WITH'
            - 'ID_LIST_CONTAINS' | 'ID_LIST_NOT_CONTAINS'
            - 'IDLR_CONTAINS' | 'IDLR_NOT_CONTAINS' | 'IDLR_CONTAINS_RECURSIVE'
            - 'LIST_CONTAINS' | 'LIST_NOT_CONTAINS'
            - 'DATE_EQUALS' | 'DATE_GT' | 'DATE_LT' | 'DATE_GTE' | 'DATE_LTE'
            - 'BOOLEAN_EQUALS' | 'BOOLEAN_NOT_EQUALS'
            - 'ATTACHED_OBJECT_TYPE_EQUALS' | 'ATTACHED_OBJECT_TYPE_NOT_EQUALS' — Filters on the attached object's type (a single AttachedObjectType value).
            - 'ATTACHED_OBJECT_EQUALS' | 'ATTACHED_OBJECT_NOT_EQUALS' — Compares an attached object as a (type, id) pair. The column is a tuple ``(type_expr, id_expr)`` and the value is a two-element list ``[type, id]`` (e.g. ``["tag", "5"]``). Filtering by the raw id alone is meaningless because ids collide across entity types (tag 5, code 5, sdoc 5 are different objects), so the type is always part of the comparison.
            - 'SPAN_ANNOTATION_CONTAINS' | 'SPAN_ANNOTATION_NOT_CONTAINS' — Filters by a single span annotation, given as a [code_id, span_text] pair. The column is an aggregated 2-D array of ``[code_id, span_text]`` string pairs (e.g. ``subquery_dict.SPAN_ANNOTATIONS``), so membership is tested by checking whether the pair is an element of that array.
          - `value` union, required — The value the column is compared against
            - boolean
            - string
            - integer
            - string[]
            - array[]
              - …
        - FilterSdocColumnsInput — recursive
    - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
  - `sorts` SortSdocColumns[], required
    - `column` union, required — The column to sort by: an enum member, or an int id referring to a project-metadata column
      - 'SD_SOURCE_DOCUMENT_TYPE' | 'SD_SOURCE_DOCUMENT_NAME' | 'SD_TAG_ID_LIST_RECURSIVE' | 'SD_CODE_ID_LIST_RECURSIVE' | 'SD_FOLDER_ID_LIST_RECURSIVE' | 'SD_USER_ID_LIST' | 'SD_SPAN_ANNOTATIONS'
      - integer
    - `direction` 'asc' | 'desc', required — Sort direction. `apply` appends `.nulls_last()` so rows missing a value sink to the bottom regardless of direction.

## Response `200`

Successful Response

- PerspectivesVisualization
  - `aspect_id` integer, required — ID of the aspect this visualization belongs to
  - `clusters` ClusterRead[], required — List of clusters in the visualization
    - `id` integer, required — ID of the cluster
    - `aspect_id` integer, required — ID of the aspect this cluster belongs to
    - `parent_cluster_id` integer, nullable, required — ID of the parent cluster, if any
    - `is_outlier` boolean, required — Whether the cluster is an outlier
    - `name` string, required — Name of the cluster
    - `description` string, required — Description of the cluster
    - `level` integer, required — Hierarchical level of the cluster
    - `x` number, required — X coordinate for visualization
    - `y` number, required — Y coordinate for visualization
    - `top_words` string[], nullable, required — Top words associated with the cluster
    - `top_word_scores` number[], nullable, required — Scores of the top words
    - `top_docs` integer[], nullable, required — IDs of top documents for the cluster
  - `docs` PerspectivesDoc[], required — List of documents in the visualization
    - `sdoc_id` integer, required — ID of the source document
    - `cluster_id` integer, required — ID of the cluster this document belongs to
    - `x` number, required — X coordinate of the document in the visualization
    - `y` number, required — Y coordinate of the document in the visualization
    - `is_accepted` boolean, required — Indicates whether the document<->cluster assignment is accepted by a user
    - `in_searchresult` boolean, required — Indicates whether the document is part of the search result
    - `is_outlier` boolean, required — Indicates whether the document is an outlier

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-20** `28b2f0e8bc01` — 1 info
  - added `#/components/schemas/AttachedObjectTypeOperator, #/components/schemas/AttachedObjectOperator, #/components/schemas/SpanAnnotationOperator` to the `filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/operator` request property `anyOf` list
- **2026-07-21** `ebfa22e4da0a` — 2 info
  - added the new `SD_FOLDER_ID_LIST_RECURSIVE` enum value to the request property `filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/`
  - added the new `SD_FOLDER_ID_LIST_RECURSIVE` enum value to the request property `sorts/items/column/anyOf[subschema #1: SdocColumns]/`
- **2026-07-20** `01c6f5cdc4f3` — 4 breaking, 5 info
  - removed the enum value `SD_CODE_ID_LIST` of the request property `filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/`
  - removed the enum value `SD_CODE_ID_LIST` of the request property `sorts/items/column/anyOf[subschema #1: SdocColumns]/`
  - removed the enum value `SD_TAG_ID_LIST` of the request property `filter/items/items/anyOf[subschema #1: FilterExpression[SdocColumns]]/column/anyOf[subschema #1: SdocColumns]/`
  - removed the enum value `SD_TAG_ID_LIST` of the request property `sorts/items/column/anyOf[subschema #1: SdocColumns]/`
  - …5 more
- …earlier changes not shown

[Full history](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api/changes/perspectives/visualize_documents/:aspect_id/post.md)

---

[API](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api.md) · [All operations](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uhh-lt/discourse-analysis-tool-suite-api/revisions/a84d27ef7a0d/schema)