magnifying-glass-chartInsights

Query workspace data, explore schema metadata, and get health digests through the platform insights endpoints.

The Insights endpoints let you run read-only SQL queries against workspace data, discover available tables and functions, and retrieve workspace health digests.

Endpoints

Method
Path
Description

POST

/insights/sql

Execute a read-only SQL query

GET

/insights/schema

List available tables, columns, and functions

GET

/insights/digest

Get a cached workspace health digest

GET

/insights/suggestions

Get contextual starter questions

Execute SQL Query

POST /insights/sql

Runs a read-only SQL query against the workspace's data warehouse.

Request Body

Field
Type
Required
Description

sql

string

Yes

SQL query to execute

Response

Field
Type
Description

results

array of objects

Query result rows (null if error)

count

integer

Number of rows returned

error

string

Error message if the query failed

List Schema

GET /insights/schema

Returns available tables, columns, and functions in the workspace schema.

Response

Field
Type
Description

lakebase_tables

object

Map of table name to column definitions (column name to type)

databricks_catalogs

array of strings

Available catalog names

uc_functions

array of objects

Unity Catalog functions with name and description

ai_functions

array of strings

Available AI function names

Get Health Digest

GET /insights/digest

Returns a cached workspace health digest (refreshed every 5 minutes) with entity counts, data quality signals, and suggested questions.

Response

The response includes:

Field
Type
Description

highlights

array of objects

Key metrics, each with label and value

trend

object

Trend data with title and data (array of date/value points)

suggested_questions

array of strings

Recommended queries to explore further

Get Suggestions

GET /insights/suggestions

Returns contextual starter questions for exploring workspace data.

Response

Field
Type
Description

suggestions

array of strings

Suggested questions for data exploration

Last updated

Was this helpful?