addedInput schema / properties
Added value: +{
+ "includeReadability": {
+ "default": true,
+ "description": "When true, include the statistics.readability block (Flesch, Gunning Fog, Coleman-Liau, ARI). Set false to skip the readability computation.",
+ "type": "boolean"
+ },
+ "includeSentiment": {
+ "default": false,
+ "description": "Reserved flag echoed back under options.includeSentiment; no sentiment block is produced.",
+ "type": "boolean"
+ },
+ "text": {
+ "description": "The text to analyze. Must be non-empty; a blank value returns a 400 error.",
+ "examples": [
+ "The quick brown fox jumps over the lazy dog."
+ ],
+ "minLength": 1,
+ "type": "string"
+ }
+}
changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "options": {
+ "description": "Echoed request options.",
+ "properties": {
+ "includeReadability": {
+ "description": "Effective readability flag used.",
+ "type": "boolean"
+ },
+ "includeSentiment": {
+ "description": "Effective sentiment flag (echo only).",
+ "type": "boolean"
+ },
+ "textLength": {
+ "description": "UTF-8 length of the analyzed text.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "statistics": {
+ "description": "Nested metrics grouped by category.",
+ "properties": {
+ "advanced": {
+ "description": "Averages, lexical diversity, most-common words, longest/shortest word, word-length distribution.",
+ "type": "object"
+ },
+ "basic": {
+ "description": "Core counts.",
+ "properties": {
+ "characters": {
+ "description": "Total UTF-8 character count.",
+ "type": "integer"
+ },
+ "charactersWithoutSpaces": {
+ "description": "Characters excluding spaces.",
+ "type": "integer"
+ },
+ "charactersWithoutWhitespace": {
+ "description": "Characters excluding all whitespace.",
+ "type": "integer"
+ },
+ "lines": {
+ "description": "Total line count.",
+ "type": "integer"
+ },
+ "nonEmptyLines": {
+ "description": "Lines with non-whitespace content.",
+ "type": "integer"
+ },
+ "paragraphs": {
+ "description": "Non-empty paragraph count.",
+ "type": "integer"
+ },
+ "sentences": {
+ "description": "Sentence count (split on . ! ?).",
+ "type": "integer"
+ },
+ "uniqueWords": {
+ "description": "Distinct lowercased words.",
+ "type": "integer"
+ },
+ "words": {
+ "description": "Word count (A-Za-z runs).",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "characters": {
+ "description": "Per-class counts (letters, digits, spaces, punctuation, uppercase, lowercase, special) and most-common characters.",
+ "type": "object"
+ },
+ "readability": {
+ "description": "Present only when includeReadability is true. Flesch Reading Ease, Flesch-Kincaid grade, Gunning Fog, Coleman-Liau, Automated Readability, plus interpretation. Score fields are null when the text has no words/sentences.",
+ "type": "object"
+ },
+ "time": {
+ "description": "Reading and speaking time estimates at multiple WPM speeds (minutes, formatted, wpm).",
+ "type": "object"
+ },
+ "words": {
+ "description": "Word totals, average/shortest/longest length, and length-category buckets.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "success": {
+ "description": "True when analysis succeeded.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+}