Skip to main content
Version: Beta

searchDocumentImages

description

Return images from the documents according to the combination of the given SearchFilter and ImageFilter. For search-specific errors see SearchErrors enum.

The exact number of results is not guaranteed. The maximum number is determined by the "limit" argument, but you can get less than that and even 0 results on the page, but still more results are available on the next pages. Please, use SearchDocumentImageResponse.cursor to check if there are more results available.

searchDocumentImages(
filter: SearchDocumentImageFilter
limit: Int = 4
cursor: String
sorting: SearchSorting
): SearchDocumentImageResponse

Arguments

searchDocumentImages.filter ● SearchDocumentImageFilter input

searchDocumentImages.limit ● Int scalar

Limits the number of results. The maximum limit is 20.

searchDocumentImages.cursor ● String scalar

Pagination is cursor based. To get the next page of results, provide a cursor from a previous response. When using a cursor, make sure the supplied filters stay the same as in the initial request, otherwise, the results may be unpredictable. If you don't get a cursor in a response, it means there are no more results.

searchDocumentImages.sorting ● SearchSorting input

Sets sorting order for search results

Type

SearchDocumentImageResponse object

Loading...