Skip to main content
​
column
string
required

The actual column name in the database/SQL query

​
datatype
enum<string>
required

The column's data type (can be an override of the warehouse-reported datatype, for JSON string columns for example).

Available options:
number,
string,
date,
boolean,
json,
binary,
other,
​
dataTypeFromWarehouse
enum<string>
read-only

The warehouse-reported datatype.

Available options:
number,
string,
date,
boolean,
json,
binary,
other,
​
numberFormat
enum<string>
Available options:
,
currency,
time:seconds,
time:milliseconds,
memory:bytes,
memory:kilobytes
​
jsonFields
object

For JSON columns, defines the structure of nested fields

​
name
string

Display name for the column (can be different from the actual column name)

​
description
string
Maximum string length: 10000
​
alwaysInlineFilter
boolean
default:false

Whether this column should always be included as an inline filter in queries

​
deleted
boolean
default:false
​
isAutoSliceColumn
boolean
default:false

Whether this column can be used for auto slice analysis. This is an enterprise feature.

​
autoSlices
string[]

Specific slices to automatically analyze for this column.

​
lockedAutoSlices
string[]

Locked slices that are protected from automatic updates. These will always be included in the slice levels even if they're not in the top values query results.

​
isVirtual
boolean
default:false

Whether this is a virtual (computed) column defined by a SQL expression rather than detected from the fact table SQL. Can be set when creating a column, but a column's origin cannot be changed afterwards — sending a value that contradicts an existing column is rejected.

​
sql
string

For virtual columns, the SQL expression that computes the column value. Only valid on a virtual column; when omitted from an update, the existing expression is preserved.

​
topValues
string[]
read-only

The most common values for this column, sampled from the warehouse to populate filter pickers and auto slices. Read-only.

​
topValuesDate
string<date-time>
read-only

When topValues was last refreshed for this column.

​
dateCreated
string<date-time>
read-only
​
dateUpdated
string<date-time>
read-only