Models

Create a model

Creates a new model within an organization. Requires admin access to the organization.

post/api/public/organizations/{orgId}/models

Request

orgIdstring required

Organization ID

namestring required

Human-readable model name

referenceNamestring

Stable SQL reference name for the model

descriptionstring

Model description

databaseConnectionIdstring required

Data source ID

sqlQuerystring required

SQL query that defines the reusable dataset

defaultTimeColumnstring nullable

Default date result column, or null for no default

synonymsstring[]

Alternative names for the model

grainstring

What one row in the model represents

keyColumnsstring[]

Columns that uniquely identify a row

usageGuidancestring

Guidance about when and how to use the model

Model created successfully

No recorded changes to this operation across all 1 revision of this API.