Run workspace query

Validates and executes a workspace-scoped SQL query, returning rows and execution metadata.

POST/api/analytics/workspace-query

Validates and executes a workspace-scoped SQL query, returning rows and execution metadata.

Request Body

application/json

Request payload for Run workspace query.

sql*string

Workspace-scoped SQL statement to validate and execute.

Example"select id, name from customers limit 25"

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/analytics/workspace-query" \  -H "Content-Type: application/json" \  -d '{    "sql": "select id, name from customers limit 25"  }'

{
  "sql": "select id, name from customers limit 25",
  "normalizedSql": "select id, name from customers limit 25",
  "usedTables": [
    "customers"
  ],
  "table": {
    "columns": [
      "customer_name"
    ],
    "rows": [
      [
        "Acme"
      ]
    ]
  },
  "records": [
    {}
  ],
  "ascii": "| id | name |",
  "rowCount": 0,
  "executionTimeMs": 0,
  "truncated": false,
  "cached": false,
  "warnings": [
    "Result limited to 25 rows."
  ]
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Run workspace query

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`