---
title: "Perform word frequency analysis."
method: POST
path: "/word_frequency/analysis"
tags: ["word_frequency"]
---

# Perform word frequency analysis.

`POST /word_frequency/analysis`

## Query parameters

- `project_id` integer, required
- `page` integer, required
- `page_size` integer, required

## Request body

- BodyWordFrequencyWordFrequencyAnalysis
  - `filter` FilterWordFrequencyColumns, required
    - `id` string, required
    - `items` union[], required
      - union
        - FilterExpressionWordFrequencyColumns
          - `id` string, required
          - `column` union, required
            - 'WF_WORD' | 'WF_WORD_FREQUENCY' | 'WF_WORD_PERCENT' | 'WF_SOURCE_DOCUMENT_FREQUENCY' | 'WF_SOURCE_DOCUMENT_PERCENT' | 'WF_SOURCE_DOCUMENT_NAME' | 'WF_TAG_ID_LIST_RECURSIVE' | 'WF_CODE_ID_LIST_RECURSIVE' | 'WF_FOLDER_ID_LIST_RECURSIVE' | 'WF_USER_ID_LIST' | 'WF_SPAN_ANNOTATIONS'
            - integer
          - `operator` union, required
            - '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'
          - `value` union, required
            - boolean
            - string
            - integer
            - string[]
            - array[]
              - …
        - FilterWordFrequencyColumns — recursive
    - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
  - `sorts` SortWordFrequencyColumns[], required
    - `column` union, required
      - 'WF_WORD' | 'WF_WORD_FREQUENCY' | 'WF_WORD_PERCENT' | 'WF_SOURCE_DOCUMENT_FREQUENCY' | 'WF_SOURCE_DOCUMENT_PERCENT' | 'WF_SOURCE_DOCUMENT_NAME' | 'WF_TAG_ID_LIST_RECURSIVE' | 'WF_CODE_ID_LIST_RECURSIVE' | 'WF_FOLDER_ID_LIST_RECURSIVE' | 'WF_USER_ID_LIST' | 'WF_SPAN_ANNOTATIONS'
      - integer
    - `direction` 'asc' | 'desc', required

## Response `200`

Successful Response

- WordFrequencyResult
  - `total_results` integer, required — The total number of word_frequencies. Used for pagination.
  - `sdocs_total` integer, required — The total number of SourceDocuments.
  - `words_total` integer, required — The total number of words.
  - `word_frequencies` WordFrequencyStat[], required — The WordFrequencies.
    - `word` string, required — The word.
    - `word_percent` number, required — The percentage of the word.
    - `count` integer, required — The SourceDoument IDs.
    - `sdocs` integer, required — The number of SourceDocuments.
    - `sdocs_percent` number, required — The percentage of SourceDocuments.

## Other responses

- `422` — Validation Error

---

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