v3

latestSwagger 2.02026-07-139789260.9 KB

Get data using search.

post/search/query

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

keywordsstring

The keywords applied to all searchable fields.

limitinteger

The limit of the number of the search result. default value is 50; maximum value is 1000.

continuationTokenstring

The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.

{"stackTrail":"components:schemas:QueryOptions:properties:filter","oasType":"schema","type":"unknown","description":"The filter for the search. See examples for the usage of supported filters."}

Response

The request has succeeded.

@search.countinteger

The total number of search results (not the number of documents in a single page).

@search.count.approximateboolean

'True' if the '@search.count' is an approximate value and vise versa.

continuationTokenstring

The token used to get next batch of data. Absent if there's no more data.