Sign in

Lists keywords across the Context

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

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

Changed in 1 of the 5 revisions of this API.37

  • 9f159871306737See the full diff
    • ▲

      the page response's property type/format changed from integer/int32 to object/ for status 200

      response-property-type-changed

    • ▲

      removed the required property pageSize from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property total from the response with the 200 status

      response-required-property-removed

    • ○

      added the new optional query request parameter count

      new-optional-request-parameter

    • ○

      added the new optional query request parameter cursor

      new-optional-request-parameter

    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property page/nextCursor to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property page/totalSize to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property page/hasMore to the response with the 200 status

      response-required-property-added