Models

List Models

List models  <b><a target='_blank' href='https://evidence.dev/pricing'>Team Plan and Above</a></b>

get/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

Query parameters

namestring
Example:our_new_model

Name of the model; skip to get all models

idstring
Example:models_<uuid>

Id of the model to save for existing model

force'true' | 'false'
Example:true

Force new metadata fetch of the models

Response

Data returning...

OR
unknown required

Example response

{
  "id": "1111-2222-3333-4444",
  "name": "our_new_model",
  "description": "Show sales per month",
  "createdBy": "user_id_1234567",
  "updatedBy": "user_id_123",
  "schedule": 12,
  "createdAt": "2023-07-05Z10:10T",
  "updatedAt": "2023-07-05Z10:10T",
  "query": "SELECT * FROM table",
  "status": "SUCCESS",
  "exportDurationMS": 1000,
  "lastSuccessExport": "2021-01-01T00:00:00Z",
  "lastRefreshTime": "2021-01-01T00:00:00Z",
  "nextRefreshTime": "2021-01-02T02:02:00Z",
  "error": "DB::Exception: Identifier 'sales.rep' cannot be resolved from table with name sales.",
  "engine": "S3",
  "primaryKey": "sales_dept"
}

Changes

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