Search

Export search results as a background CSV job

Queues a background job that exports the matching search results to CSV. Track it via /v1/csvAsyncJobs and download the file from /v1/csvAsyncJobs/{jobId}/result once completed.

get/v1/search/export/async

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/search/export/async
  • Auth: HTTP bearer

Query parameters

qstring

Search Query Text

indexstring

ElasticSearch Index name, defaults to table

deletedboolean

Filter documents by deleted param. By default deleted is false

query_filterstring

Elasticsearch query appended to the query string generator

post_filterstring

Elasticsearch query that will be used as a post_filter

sort_fieldstring

Sort the search results by field

sort_orderstring

Sort order asc or desc, defaults to desc

sizeinteger

Maximum number of rows to export

frominteger

Starting offset for the export

Response

Export job accepted

jobIdstring
messagestring

Changes

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