DocsService

SearchDocs

Keyword search across Sift's product documentation.

get/api/v1/docs:search

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/docs:search
  • Auth: HTTP bearer

Query parameters

querystring required

Keyword query, e.g. "asset channels CEL". Required.

maxResultsinteger

Maximum hits to return. Defaults to 10; values above the hard cap of 25 are coerced to 25. Optional.

Response

A successful response.

totalScannedinteger

Total number of doc pages scanned to produce these hits.

Changes

No recorded changes to this operation across all 1 revision of this API.