Scan query source schema

Error

A valid request URL is required to generate request examples

{
  "results": {
    "tables": [
      {
        "columns": [
          {
            "description": "<string>",
            "label": "<string>",
            "reference": "<string>"
          }
        ],
        "description": "<string>",
        "label": "<string>",
        "reference": "<string>"
      }
    ]
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

GET

api

projects

{projectUuid}

query-sources

{sourceType}

schema

Error

A valid request URL is required to generate request examples

{
  "results": {
    "tables": [
      {
        "columns": [
          {
            "description": "<string>",
            "label": "<string>",
            "reference": "<string>"
          }
        ],
        "description": "<string>",
        "label": "<string>",
        "reference": "<string>"
      }
    ]
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid

string

required

sourceType

enum<string>

required

Discriminator for every query source a project can execute queries against. A query source is anything that can scan a schema and run a query returning the standard table format (ResultColumns + rows behind a queryUuid): the project warehouse, the semantic layer, the DuckDB compose engine, and — later — CSV uploads, HTTP APIs, Google Sheets, etc.

Deliberately NOT WarehouseTypes: sources are not warehouses, they plug in above the warehouse client layer.

Available options:

semanticLayer,

sql,

duckdb

Response

Success

results

object

required

The standard shape every source's schema scan returns.

Show child attributes

status

enum<string>

required

Available options:

ok

⌘I