Query Insights

Get a generic execution plan for a query

Returns EXPLAIN (GENERIC_PLAN, FORMAT JSON) for the normalized query text of the given pg_stat_statements queryid. The query is never executed (no ANALYZE) and is only planned if its stored text is fully normalized (contains no literals) and is a single SELECT/WITH statement. PostgreSQL 16+ only. A reachable instance whose queryid has no matching row returns HTTP 404 with status: not_found; unplannable/unsupported/version-too-old cases return HTTP 409 with a reason.

Key Parameters:

  • id: The instance whose database to inspect
  • queryid: The queryid obtained from the slow-queries endpoint
get/instances/{id}/query-plan

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/instances/{id}/query-plan
  • Auth: HTTP bearer

Response

Generic plan produced successfully

object required

Changes

No recorded changes to this operation across all 1 revision of this API.