Skip to main content
POST
Create a model

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

Body

application/json
name
string
required

Human-readable model name

Required string length: 1 - 100
databaseConnectionId
string
required

Data source ID

sqlQuery
string
required

SQL query that defines the reusable dataset

Required string length: 1 - 100000
referenceName
string

Stable SQL reference name for the model

Required string length: 1 - 100
description
string

Model description

Maximum string length: 10000
measures
object[]

Ordered reusable aggregate expressions

Maximum array length: 50
segments
object[]

Ordered reusable predicate expressions

Maximum array length: 50
defaultTimeColumn
string | null

Default date result column, or null for no default

Required string length: 1 - 256
synonyms
string[]

Alternative names for the model

Maximum array length: 20
Required string length: 1 - 100
grain
string

What one row in the model represents

Maximum string length: 10000
keyColumns
string[]

Columns that uniquely identify a row

Maximum array length: 10
Required string length: 1 - 256
relationships
object[]

Relationships from this model to other models

Maximum array length: 50
usageGuidance
string

Guidance about when and how to use the model

Maximum string length: 10000
columnSynonyms
object[]

Alternative names for model result columns

Response

Model created successfully

data
object
required