Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Query Runner

Run Query

Submits a query for asynchronous execution against the connection.

This endpoint returns immediately with a query task ID. It does not wait for the query to finish. Poll GET /api/queries/{id} until status reaches done or failed.

Only the user who created the query can fetch its results later. Query results are stored temporarily and may expire; use the expires field from the result endpoint to understand how long they will remain available.

post/api/connections/{connection_id}/query

Path parameters

connection_idstring uuid required

Unique identifier of the connection to run the query against.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the connection to run the query against.

Query parameters

querystring

The query to execute against the connection.

Example:SELECT * FROM table

The query to execute against the connection.

Headers

X-Polytomic-Versionstring

Request body

querystring

The query to execute against the connection.

Example request

{
  "query": "SELECT * FROM table"
}

Response

OK

Example response

{
  "data": {
    "count": 10,
    "expires": "2021-01-01T00:00:00Z",
    "fields": [
      "name",
      "age"
    ],
    "id": "43d893ef-322b-47da-badb-3cf10d13a556"
  }
}