POST /api/v202606/edx/validate

Validates a KQL query without executing it, returning syntax and semantic diagnostics.

ValidateV202606
Lets the editor surface problems before a run. Always returns 200 OK; query problems are reported in the body as errors (with warnings alongside), not as an HTTP error. The limit on the request is ignored. Requires the Edx feature flag.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

EdxQueryRequestV202606
Property Description Type
kql The KQL query text. string
limit Optional row cap (defaults applied server-side; hard-capped at 100k). integer (int32)
Example Request Body application/json 
{  "kql": "string",  "limit": 1
}

Responses

200 Validation completed; inspect `valid`, `errors`, and `warnings`. The request succeeded and the response body contains the requested data.

Response Body Parameters

EdxValidationResultV202606
Property Description Type
errors EdxDiagnosticV202606[]
EdxDiagnosticV202606 properties
Property Description Type
code string
length Length of the problematic text, if known. integer (int32)
message string
position Character offset in the KQL text where the issue starts, if known. integer (int32)
valid boolean
warnings EdxDiagnosticV202606[]
EdxDiagnosticV202606 properties
Property Description Type
code string
length Length of the problematic text, if known. integer (int32)
message string
position Character offset in the KQL text where the issue starts, if known. integer (int32)
Example Response application/json 
{  "errors": [
    {    "code": "string",    "length": 1,    "message": "string",    "position": 1
  }
  ],  "valid": false,  "warnings": [
    {    "code": "string",    "length": 1,    "message": "string",    "position": 1
  }
  ]
}