Back to Cube

Core Data APIs

docs-mintlify/reference/core-data-apis/index.mdx

1.6.435.6 KB
Original Source

Core Data APIs

Core Data APIs enable you to query and retrieve data from your Cube semantic layer using various protocols and formats, including SQL, DAX, REST (JSON), and GraphQL.

Choosing the Right API

All Core Data APIs share common querying concepts and support authentication, security contexts, and access policies defined in your semantic layer.

<Note>

See this GitHub issue for an unofficial, community-maintained client library for Python.

</Note>

Data modeling

Support for data modeling features differ across APIs, integrations, and visualization tools. Some of the features with partial support are listed below:

Feature✅ Supported in
HierarchiesMicrosoft Power BI via the DAX API
Cube Cloud for Excel
Cube Cloud for Sheets
Tableau via Semantic Layer Sync

Also, supported in Playground | | Flat folders | Microsoft Power BI via the DAX API Cube Cloud for Excel Cube Cloud for Sheets Tableau via Semantic Layer Sync Apache Superset via Semantic Layer Sync Preset via Semantic Layer Sync

Also, supported in Playground | | Nested folders | Microsoft Power BI via the DAX API | | Custom time formats | Playground and Workbooks |

Personal Core Data API Token

Cube users can generate a personal token to authenticate SQL API connections from external tools like BI dashboards, notebooks, and SQL clients. Navigate to Preferences → Personal Core Data API Token and click Generate Token.

The token authenticates as that user, so all groups, user attributes, and data access policies are applied to queries made with this token. The page also provides connection instructions including host, port, and database name for your deployment.

Authentication methods

Support for authentication methods differ across APIs, integrations, and visualization tools:

Method✅ Supported in
User name and passwordDAX API
Semantic Layer Sync
SQL API
Kerberos and NTLMDAX API
Identity providerCube Cloud for Excel
Cube Cloud for Sheets
JSON Web TokenREST (JSON) API
GraphQL API