Skip to main content
​
column
string
required

The actual column name in the database/SQL query

​
datatype
enum<string>
required
Available options:
number,
string,
date,
boolean,
json,
binary,
other,
​
numberFormat
enum<string>
Available options:
,
currency,
time:seconds,
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.

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