Dashboards

List Dashboards

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

page_contextany ofOptional

string · enumOptionalPossible values:

or

nullOptional

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/dashboards

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/dashboards HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "text",
      "title": "text",
      "description": "text",
      "page_context": "text",
      "panels": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "filters": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "refresh_interval": 1,
      "is_active": true,
      "created_by": "text",
      "created_at": "2026-05-12T13:12:38.148Z",
      "updated_at": "2026-05-12T13:12:38.148Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create Dashboard

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

slugstring · min: 2 · max: 128RequiredPattern: ^[a-z0-9][a-z0-9\-]*$

titlestring · min: 1 · max: 256Required

descriptionany ofOptional

string · max: 2000Optional

or

nullOptional

page_contextany ofOptional

string · enumOptionalPossible values:

or

nullOptional

refresh_intervalinteger · min: 10 · max: 86400OptionalDefault: 300

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/{workspace_id}/dashboards

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/dashboards HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "home",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 300
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "text",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:12:38.148Z",
  "updated_at": "2026-05-12T13:12:38.148Z"
}

Get Dashboard

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

dashboard_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idany ofOptional

string · uuidOptional

or

nullOptional

slugstringRequired

URL-safe identifier

titlestringRequired

Dashboard display title

descriptionany ofOptional

Human-readable description

stringOptional

or

nullOptional

page_contextany ofOptional

Developer console page where this dashboard renders

stringOptional

or

nullOptional

refresh_intervalintegerRequired

Auto-refresh interval in seconds

is_activebooleanRequired

Whether the dashboard is active

created_byany ofOptional

Creator identifier

stringOptional

or

nullOptional

created_atany ofOptional

When the dashboard was created

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

When the dashboard was last updated

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/dashboards/{dashboard_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/dashboards/{dashboard_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "text",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:12:38.148Z",
  "updated_at": "2026-05-12T13:12:38.148Z"
}

Update Dashboard

put

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

dashboard_idstring · uuidRequired

Body

application/json

slugany ofOptional

string · min: 2 · max: 128OptionalPattern: ^[a-z0-9][a-z0-9\-]*$

or

nullOptional

titleany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

descriptionany ofOptional

string · max: 2000Optional

or

nullOptional

page_contextany ofOptional

string · enumOptionalPossible values:

or

nullOptional

panelsany ofOptional

or

nullOptional

filtersany ofOptional

or

nullOptional

refresh_intervalany ofOptional

integer · min: 10 · max: 86400Optional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idany ofOptional

string · uuidOptional

or

nullOptional

slugstringRequired

URL-safe identifier

titlestringRequired

Dashboard display title

descriptionany ofOptional

Human-readable description

stringOptional

or

nullOptional

page_contextany ofOptional

Developer console page where this dashboard renders

stringOptional

or

nullOptional

refresh_intervalintegerRequired

Auto-refresh interval in seconds

is_activebooleanRequired

Whether the dashboard is active

created_byany ofOptional

Creator identifier

stringOptional

or

nullOptional

created_atany ofOptional

When the dashboard was created

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

When the dashboard was last updated

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

put

/v1/{workspace_id}/dashboards/{dashboard_id}

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/dashboards/{dashboard_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "home",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "text",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:12:38.148Z",
  "updated_at": "2026-05-12T13:12:38.148Z"
}

Delete Dashboard

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

dashboard_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/{workspace_id}/dashboards/{dashboard_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/dashboards/{dashboard_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Dashboard By Slug

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

slugstringRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idany ofOptional

string · uuidOptional

or

nullOptional

slugstringRequired

URL-safe identifier

titlestringRequired

Dashboard display title

descriptionany ofOptional

Human-readable description

stringOptional

or

nullOptional

page_contextany ofOptional

Developer console page where this dashboard renders

stringOptional

or

nullOptional

refresh_intervalintegerRequired

Auto-refresh interval in seconds

is_activebooleanRequired

Whether the dashboard is active

created_byany ofOptional

Creator identifier

stringOptional

or

nullOptional

created_atany ofOptional

When the dashboard was created

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

When the dashboard was last updated

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/dashboards/by-slug/{slug}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/dashboards/by-slug/{slug} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "title": "text",
  "description": "text",
  "page_context": "text",
  "panels": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "filters": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "refresh_interval": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:12:38.148Z",
  "updated_at": "2026-05-12T13:12:38.148Z"
}

Execute Dashboard

post

Execute all panel queries and return results for rendering.

SQL injection is mitigated by ResearchQueryService.execute_sql, which calls _validate_read_only_sql to block DROP/TRUNCATE/ALTER/CREATE/GRANT/REVOKE/ DELETE/UPDATE/INSERT statements. Catalog-level access is further restricted by the service principal's Databricks grants (read-only on analytics catalog).

Every panel query MUST reference the :ws_id parameter so that ResearchQueryService binds it to the requesting workspace. Queries without this binding are rejected to prevent cross-tenant data access.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

dashboard_idstring · uuidRequired

Body

application/json

or

nullOptional

Responses

200

Successful Response

application/json

dashboard_idstring · uuidRequired

422

Validation Error

application/json

post

/v1/{workspace_id}/dashboards/{dashboard_id}/execute

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/dashboards/{dashboard_id}/execute HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "filter_values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "dashboard_id": "123e4567-e89b-12d3-a456-426614174000",
  "results": [
    {
      "panel_id": "text",
      "columns": [
        "text"
      ],
      "rows": [
        []
      ],
      "error": "text"
    }
  ]
}