Models

Validate

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

post/v1/workspaces/models/validate

Request

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

Request body

namestring required

Name of the model

querystring required

Query of 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 if for MergeTree engine: MergeTree, AggregatingMergeTree...

Example request

{
  "name": "our_new_model",
  "query": "select * from demo_daily_orders;",
  "engine": "MergeTree",
  "primaryKey": "sales_dept"
}

Response

Data returning...

OR
unknown required

Example response

{
  "name": "our_new_model",
  "stats": {
    "rows": 1000,
    "bytes": 1000
  },
  "queryHash": "aead1234567890",
  "query": "SELECT * FROM table",
  "engine": "MergeTree",
  "primaryKey": "sales_dept"
}

Changes

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