About this endpoint
What it does
Scores raw plain text for readability and returns text statistics plus a readability result object. The algorithm used is controlled by the request body language field, which switches between English and German scoring.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | Raw text to analyse. |
| language | ENUM | No | Scoring algorithm to use. Allowed values: english, german. Default: english. english returns Flesch-Kincaid Reading Ease; german returns Wiener Sachtextformel. |
Response
Returns a JSON object with a data object field. Inside data, the response includes a stats object with text metrics, and one readability result object: flesh_kincaid_reading_ease for English scoring or wiener_sachtextformel for German scoring.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Response wrapper containing stats and one readability result object. |
| data.stats | Object | No | Text statistics for the analysed input. |
| data.stats.words | Integer | No | Number of words. |
| data.stats.sentences | Integer | No | Number of sentences. |
| data.stats.characters | Integer | No | Number of characters. |
| data.stats.paragraphs | Integer | No | Number of paragraphs. |
| data.stats.reading_time | Number | No | Estimated reading time in seconds. |
| data.stats.speaking_time | Number | No | Estimated speaking time in seconds. |
| data.stats.avg_word_length | Number | No | Average word length. |
| data.stats.avg_sentence_length | Number | No | Average sentence length. |
| data.stats.avg_paragraph_length | Number | No | Average paragraph length. |
| data.flesh_kincaid_reading_ease | Object | No | Readability result returned for english scoring. Contains class, label, level, score, and class_label. |
| data.flesh_kincaid_reading_ease.class | String | No | Readability class. |
| data.flesh_kincaid_reading_ease.label | Boolean | No | Whether the text meets a standard readability threshold. |
| data.flesh_kincaid_reading_ease.level | Number | No | Readability level. |
| data.flesh_kincaid_reading_ease.score | Number | No | Readability score. |
| data.flesh_kincaid_reading_ease.class_label | String | No | Human-readable class label. |
| data.wiener_sachtextformel | Object | No | Readability result returned for german scoring. Contains class, label, level, score, and class_label. |
| data.wiener_sachtextformel.class | String | No | Readability class. |
| data.wiener_sachtextformel.label | Boolean | No | Whether the text meets a standard readability threshold. |
| data.wiener_sachtextformel.level | Number | No | Readability level. |
| data.wiener_sachtextformel.score | Number | No | Readability score. |
| data.wiener_sachtextformel.class_label | String | No | Human-readable class label. |