Playground

APIs related to query engine, which will be used to query the selected datasets.

📄️ Start a query execution

Submits a SQL statement for asynchronous execution against Athena or Redshift and returns the identifier of the new execution. A 200 means the query was accepted, not that it has finished: poll GET /queries/{queryid} for the state and GET /queries/{queryid}/results for the result set.

📄️ List the caller's query history

Returns a paginated list of queries the caller has executed, with their current state. Queries that are not yet in a terminal state are refreshed against the live engine before being returned, so their status reflects the engine rather than the last stored value.

📄️ Get query details by query id

Returns the details of a single query. The caller must be the user who submitted the query, otherwise the request is rejected with AUTH-1010. For executions that are not yet in a terminal state the status is refreshed against the live Athena or Redshift engine before it is returned, so the response can differ from the last stored value.

📄️ Stop a running query

Requests cancellation of a query. The caller must be the user who submitted the query; a Super Admin (via the X-Amorphic-Super-Admin header) may cancel any query.

📄️ Get query results

Returns the result rows of a query. The query must have reached SUCCEEDED, otherwise the request is rejected with GE-1095, and the caller must be the user who submitted it.

📄️ Get a download URL for the full query results

Returns a time-limited presigned URL for the complete result file of a query, without the 51-row cap applied by GET /queries/{queryid}/results. The query must have reached SUCCEEDED and the caller must be the user who submitted it.

📄️ List workbooks

Returns a paginated list of the query workbooks the caller has access to. Items carry a reduced attribute set: the chat and query configurations, expiry fields and title-generation flags are not included, so fetch GET /workbooks/{workbook_id} for the full record.

📄️ Create a workbook

Creates a new query workbook owned by the caller.

📄️ Get workbook details, messages, or queries

Returns one of three shapes, selected by the action query parameter. The caller needs read-only access or higher on the workbook.

📄️ Update a workbook, or stop its running queries

Has two modes, selected by the action query parameter. The caller needs editor access or higher on the workbook.

📄️ Delete a workbook

Deletes a workbook and revokes its access entries. Only the workbook owner may call this; editor access is not sufficient.