Path parameters

• id string Required

  The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the keep_on_completion parameter set to true.

Query parameters

• drop_null_columns boolean

  Indicates whether columns that are entirely null will be removed from the columns and values portion of the results. If true, the response will include an extra section under the name all_columns which has the name of all the columns.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • took number

    Time unit for milliseconds

  • is_partial boolean
  • all_columns array[object]
    Hide all_columns attributes Show all_columns attributes object

    • name string Required
    • type string Required
  • columns array[object] Required
    Hide columns attributes Show columns attributes object

    • name string Required
    • type string Required
  • values array[array] Required

    A field value.

    A field value.

  • _clusters object
    Hide _clusters attributes Show _clusters attributes object

    • total number Required
    • successful number Required
    • running number Required
    • skipped number Required
    • partial number Required
    • failed number Required
    • details object Required
      Hide details attribute Show details attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • status string Required

          Values are running, successful, partial, skipped, or failed.

        • indices string Required
        • took number

          Time unit for milliseconds

        • _shards object
          Hide _shards attributes Show _shards attributes object

          • total number Required
          • successful number
          • skipped number
          • failed number
        • failures array[object]
          Hide failures attributes Show failures attributes object

          • shard number Required
          • index
          • node string
          • reason object Required

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • profile object

    Profiling information. Present if profile was true in the request. The contents of this field are currently unstable.