Returns the current status and available results for an async SQL search or stored synchronous SQL search Added in 7.15.0

GET /_sql/async/{id}

Path parameters

  • id string Required

    Identifier for the search.

Query parameters

  • delimiter string

    Separator for CSV results. The API only supports this parameter for CSV responses.

  • format string

    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.

  • keep_alive string

    Retention period for the search and its results. Defaults to the keep_alive period for the original SQL search.

  • wait_for_completion_timeout string

    Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • id string Required
    • is_running boolean Required

      If true, the search is still running. If false, the search has finished. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

    • is_partial boolean Required

      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 only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

    • columns array[object]

      Column headings for the search results. Each object is a column.

      Hide columns attributes Show columns attributes object
    • cursor string

      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

      Values for the search results.

      Additional properties are allowed.
GET /_sql/async/{id} 
curl \
 -X GET http://api.example.com/_sql/async/{id}
Response examples (200) 
{
  "id": "string",
  "is_running": true,
  "is_partial": true,
  "columns": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "cursor": "string",
  "rows": [
    [
      {}
    ]
  ]
}