About this endpoint
What it does
Scores the readability of the provided text and returns a JSON object containing a readability object with subscore and main score breakdowns.
Query Parameter(s)
| Attribute | Type | Description |
|---|---|---|
| text | String | The text to score. Maximum length: 2,000 characters for Latin-script text (about 800 for other scripts, because the text is sent in the URL). |
Response
Returns a JSON object with a readability object field. The readability object contains a subscores object with numeric readability metrics and a mainscores object with integer totals.
| Parameter | Type | Description |
|---|---|---|
| readability | Object | Readability score details. |
| readability.subscores | Object | Individual readability subscores. |
| readability.subscores.ari | Number | Automated Readability Index score. |
| readability.subscores.fog | Number | Gunning fog score. |
| readability.subscores.lix | Number | LIX score. |
| readability.subscores.smog | Number | SMOG score. |
| readability.subscores.flesch | Number | Flesch score. |
| readability.subscores.forcast | Number | FORCAST score. |
| readability.subscores.kincaid | Number | Flesch-Kincaid score. |
| readability.subscores.coleman_liau | Number | Coleman-Liau score. |
| readability.subscores.reading_time_seconds | Integer | Estimated reading time in seconds. |
| readability.mainscores | Object | Overall readability totals. |
| readability.mainscores.total | Integer | Total score. |
| readability.mainscores.total_possible | Integer | Maximum possible total score. |



