Skip to main content
GET
Retrieve the full semantic layer for a given datamart. The response includes table and column metadata (descriptions, synonyms, column types), feedback text, a completion score, and the last-updated timestamp.
This endpoint returns data for datamarts that exist in your organization — even if no semantic layer has been configured yet. In that case, tables are returned with null/empty semantic fields.

Authentication

This endpoint requires a service token in the Authorization header. Data app API tokens are not permitted and will be rejected with a 403 error. To access your service token:
  1. Go to your Databrain dashboard and open Settings.
  2. Navigate to Settings.
  3. Find the Service Tokens section.
  4. Click the “Generate Token” button to generate a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

Headers

string
required
Bearer token for API authentication. Use your service token.

Query Parameters

string
required
The name of the datamart whose semantic layer you want to retrieve. Must match an existing datamart in your organization.

Response

object
The semantic layer data for the requested datamart.
null | object
Error object if the request failed, otherwise not present for successful requests.

Examples

HTTP Status Code Summary

Possible Errors

Next Steps

Create Semantic Layer

Add semantic metadata to your datamart

Update Semantic Layer

Modify existing semantic layer metadata

Semantic Layer Guide

Learn how to configure the semantic layer in the UI

List Datamarts

Find datamart names in your organization