BAbasedash
Models

Update a model

Updates an existing model. Requires admin access to the organization.

patch/api/public/organizations/{orgId}/models/{id}

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Organization ID

idstring required

Model ID

Request body

namestring

Human-readable model name

referenceNamestring

Stable SQL reference name for the model

descriptionstring

Model description

sqlQuerystring

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

verifiedboolean

Whether the model is verified

Response

Model updated successfully

Changes

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