BI

Dashboard and semantic model read APIs.

Operations

Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.

List dashboards

GET /api/v1/workspaces/{workspace}/dashboards

Operation ID: listDashboards
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Describe dashboard

GET /api/v1/workspaces/{workspace}/dashboards/{dashboard}

Operation ID: getDashboard
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Describe dashboard page

GET /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}

Operation ID: getDashboardPage
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Describe dashboard filter

GET /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/filters/{filter}

Operation ID: getDashboardFilter
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

List dashboard filter values

POST /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/filters/{filter}/values

Operation ID: listDashboardFilterValues
Effect: write
Confirmation: conditional
Required privilege: QUERY_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Query dashboard page

POST /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/query

Operation ID: queryDashboardPage
Effect: write
Confirmation: conditional
Required privilege: QUERY_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Describe dashboard visual

GET /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/visuals/{visual}

Operation ID: getDashboardVisual
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Query an existing dashboard visual with governed filters and compact analytical output

POST /api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/visuals/{visual}/query

Operation ID: queryDashboardVisualData
Effect: read
Confirmation: never
Required privilege: QUERY_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List semantic models

GET /api/v1/workspaces/{workspace}/semantic-models

Operation ID: listSemanticModels
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Describe semantic model

GET /api/v1/workspaces/{workspace}/semantic-models/{model}

Operation ID: getSemanticModel
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

List semantic model datasets

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/datasets

Operation ID: listSemanticDatasets
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Describe semantic model dataset

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}

Operation ID: getSemanticDataset
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

List semantic model dataset fields

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/fields

Operation ID: listSemanticFields
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Preview semantic model dataset rows

POST /api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/preview

Operation ID: previewSemanticDataset
Effect: write
Confirmation: conditional
Required privilege: PREVIEW_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Explain semantic model dataset row preview

POST /api/v1/workspaces/{workspace}/semantic-models/{model}/datasets/{dataset}/preview/explain

Operation ID: explainSemanticPreview
Effect: write
Confirmation: conditional
Required privilege: PREVIEW_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List semantic model fields

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/fields

Operation ID: listSemanticModelFields
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Query governed semantic data with typed columns, filters, pagination, and provenance

POST /api/v1/workspaces/{workspace}/semantic-models/{model}/query

Operation ID: querySemanticModel
Effect: read
Confirmation: never
Required privilege: QUERY_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Explain semantic model query

POST /api/v1/workspaces/{workspace}/semantic-models/{model}/query/explain

Operation ID: explainSemanticModelQuery
Effect: write
Confirmation: conditional
Required privilege: QUERY_DATA
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List semantic model relationships

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/relationships

Operation ID: listSemanticRelationships
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

List semantic model sources

GET /api/v1/workspaces/{workspace}/semantic-models/{model}/sources

Operation ID: listSemanticSources
Effect: read
Confirmation: never
Required privilege: VIEW_ITEM
Focused reference: JSON · Markdown

Parameters

Responses

Common error responses

These error responses apply to every operation on this page.