Path parameters

• idstring 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_columnsboolean

  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

  • tooknumber

    Time unit for milliseconds

  • is_partialboolean
  • all_columnsarray[object]
    Hide all_columns attributes Show all_columns attributes object

    • namestring Required
    • typestring Required
  • columnsarray[object] Required
    Hide columns attributes Show columns attributes object

    • namestring Required
    • typestring Required
  • valuesarray[array] Required

    A field value.

    A field value.

  • _clustersobject
    Hide _clusters attributes Show _clusters attributes object

    • totalnumber Required
    • successfulnumber Required
    • runningnumber Required
    • skippednumber Required
    • partialnumber Required
    • failednumber Required
    • detailsobject Required
      Hide details attribute Show details attribute object

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

        • statusstring Required

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

        • indicesstring Required
        • tooknumber

          Time unit for milliseconds

        • _shardsobject
          Hide _shards attributes Show _shards attributes object

          • totalnumber Required
          • successfulnumber
          • skippednumber
          • failednumber
        • failuresarray[object]
          Hide failures attributes Show failures attributes object

          • shardnumber Required
          • index
          • nodestring
          • reasonobject 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.

  • profileobject

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