View unique words with the Word Wheel

The word wheel is an alphabetical scrolling list of unique words and the number of times they appear in Indexes.

Make a Wheel Request to retrieve the Word Wheel. The server will respond with a Wheel Response.

URL: /api/wordwheel/

Method: POST

Content-Type: application/json

Wheel Request

Attribute	Description
indexesarray|null	Array of Index names to retrieve words from. Pass null to search all Indexes Default null
cursorWordstring	The word that will appear in the middle of the list. Default A
rangenumber	The number of words to find before and after the cursor word.

Wheel Response

Attribute	Description
wordListItemsarray	Array of Word List Item

Word List Item

Attribute	Description
wordstring	The unique word
countnumber	The number of occurrences of the word in requested Indexes.
beforeCursorboolean	Whether or not the word occurs before or after the Cursor word.

Example

POST Request to /api/wordwheel

Request Body:

{
    "indexes": ["Classics"],
    "cursorWord": "Soap",
    "range": 3
}

Response Body:

{
    "wordListItems": [
        {
            "word": "so",
            "count": 407,
            "beforeCursor": true
        },
        {
            "word": "soak",
            "count": 1,
            "beforeCursor": true
        },
        {
            "word": "soaked",
            "count": 1,
            "beforeCursor": true
        },
        {
            "word": "soap",
            "count": 2,
            "beforeCursor": false
        },
        {
            "word": "soaps",
            "count": 1,
            "beforeCursor": false
        },
        {
            "word": "soared",
            "count": 1,
            "beforeCursor": false
        }
    ]
}

---

Last update: June 21, 2020