Models

Save Model

Save a model from your sources  <b><a target='_blank' href='https://evidence.dev/pricing'>Team Plan and Above</a></b>

post/v1/workspaces/models

Request

  • Base URL: https://management.evidence.studio
  • URL: https://management.evidence.studio/v1/workspaces/models
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie wos-session

Request body

idstring

Id of the model to save for existing model

namestring required

Name of the model

querystring required

Query of the model

descriptionstring required

Description of the model

validationQueryHashstring required

query hash from <a href="/#tag/models/POST/v1/workspaces/models/validate">validation endpoint</a>

refreshIntervalHoursnumber

The interval in hours to refresh the model

engine'S3' | 'MergeTree' | 'SummingMergeTree' | 'AggregatingMergeTree'

Engine to build the model. <b>Available Engines:</b> <br/><br/><b>S3</b>: Stores data in bucket | Data stored in region of your organization<br/><br/><b>MergeTree</b>: General-purpose table. Faster than the default engine. | Data stored in GCP us-central1<br/><br/><b>SummingMergeTree</b>: Pre-aggregated counters or running totals — things like daily page view counts, revenue by region, or click counters | Data stored in GCP us-central1<br/><br/><b>AggregatingMergeTree</b>: You need incremental, pre-computed aggregations more complex than simple sums (e.g. unique user counts, averages, or quantiles) | Data stored in GCP us-central1<br/><br/>

primaryKeystring nullable

Required for the MergeTree engine: MergeTree, AggregatingMergeTree...

Example request

{
  "id": "models_<uuid>",
  "name": "our_new_model",
  "query": "select * from demo_daily_orders;",
  "description": "This is a description of our new model.",
  "validationQueryHash": "aead1234567890",
  "refreshIntervalHours": 12,
  "engine": "MergeTree",
  "primaryKey": "sales_dept"
}

Response

Data returning...

OR
unknown required

Example response

{
  "name": "our_new_model"
}

Changes

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