Explains in plain language what a Workbench Data Explorer KQL query does, using the AI query assistant
Use this endpoint to understand a query before running or changing it, such as one shared by someone else or
written by POST workbench/query/generate. The explanation walks through each stage of the query in business
terms. The query is not run. Restricted to ENC staff.
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
EdxAiExplainRequestV202606
| Property | Description | Type |
|---|---|---|
| kql | string |
Example Request Body
{ "kql": "string"
}Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
EdxAiExplainResponseV202606
| Property | Description | Type |
|---|---|---|
| explanation | string |
Example Response
{ "explanation": "string"
}