Get async SQL search results | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• The separator for CSV results. The API supports this parameter only for CSV responses.
• The format for the response. You must specify a format using this parameter or the Accept HTTP header. If you specify both, the API uses this parameter.
• The retention period for the search and its results. It defaults to the keep_alive period for the original SQL search.
• The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • If true, the search is still running. If false, the search has finished. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.
  • If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.
  • Column headings for the search results. Each object is a column.
    Hide columns attributes Show columns attributes object
  • The cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the Cursor HTTP header.
  • rows
    array[array] Required
    The values for the search results.