SUsurrealdb

GET /api/v1/{context_id}/documents/keywords

Changed on

Lists keywords across the Context

Request

Path parameters

context_idstring required

Spectron context id

Query parameters

qstring

Case-insensitive substring match on text

minDocumentCountinteger

Minimum number of linked documents

sortstring

Sort key

limitinteger

Max keywords to return (default 100, max 500)

cursorstring

Continuation token from the previous page's page.nextCursor. Only valid for the sort it was minted under.

countboolean

Also return page.totalSize (costs a full count of the filtered set)

pageinteger

Deprecated: zero-based page index. Use cursor.

pageSizeinteger

Deprecated: page size. Use limit.

Response

Changes

  • 9f1598713067Revision changes
    • breaking

      the response's property type changed from integer to object, and format from int32 to no format for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional query request parameter count

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status