Get the explain plan for a SQL Cleanroom Question Run

get

https://api.habu.com/v1/cleanroom-question-runs/{cleanroomQuestionRunId}/explain-plan

This operation returns the execution plan (explain plan) for the specified Cleanroom Question Run. This operation applies only to Cleanroom Questions of type SQL; it is not supported for other question types.

An explain plan describes how a Spark SQL question run's query will be executed. It can help you understand why a run might be slow, resource-intensive, or fail, and which parts of the SQL may need tuning for Spark-based execution.

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns explain plan details when successful (success=true). When the optimizer reports a business failure, returns HTTP 200 with success=false and errorMessage populated.

400Bad Request - Incorrect syntax or request

401Authorization information was missing or invalid

403This action is not allowed

404The specified resource was not found

500Internal Server Error