Returns the current status of an async SQL search or a stored synchronous SQL search Added in 7.15.0

GET /_sql/async/status/{id}

Path parameters

  • id string Required

    Identifier for the search.

Responses

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

      Identifier for the search.

    • is_running boolean Required

      If true, the search is still running. If false, the search has finished.

    • 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.

    • start_time_in_millis number

      Time unit for milliseconds

    • expiration_time_in_millis number

      Time unit for milliseconds

    • completion_status number
GET /_sql/async/status/{id} 
curl \
 -X GET http://api.example.com/_sql/async/status/{id}
Response examples (200) 
{
  "id": "string",
  "is_running": true,
  "is_partial": true,
  "": 42.0,
  "completion_status": 42.0
}