Skip to content

Commit 4969903

Browse files
docs: MDX API (#8300)
* mdx api docs * Update mdx docs --------- Co-authored-by: Artyom Keydunov <[email protected]>
1 parent 9c4606f commit 4969903

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

docs/pages/product/apis-integrations/_meta.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ module.exports = {
33
"sql-api": "SQL API",
44
"rest-api": "REST API",
55
"graphql-api": "GraphQL API",
6+
"mdx-api": "MDX API",
67
"ai-api": "AI API",
78
"javascript-sdk": "JavaScript SDK",
89
"orchestration-api": "Orchestration API",
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# MDX API
2+
3+
The MDX (MultiDimensional eXpressions) API provides a robust interface for connecting applications, such as Microsoft Excel, to the Cube Cloud semantic layer via the XMLA (XML for Analysis) standard.
4+
5+
Key Features:
6+
7+
- <b>Direct connectivity:</b> Connect Excel and other compatible applications directly to Cube Cloud using standard XMLA protocols.
8+
- <b>Advanced analytical functions:</b> Utilize the power of MDX to execute sophisticated queries that include slicing, dicing, drilling down, and rolling up of data.
9+
- <b>Real-time access:</b> Fetch live data from Cube Cloud, ensuring that your analyses and reports always reflect the most current information.
10+
11+
<WarningBox>
12+
The MDX API is available on [Cube
13+
Cloud](/getting-started#getting-started-with-cube-cloud) only. It is currently
14+
in preview.
15+
</WarningBox>
16+
17+
## Configuration
18+
19+
While the MDX API is in preview, your Cube account team will enable and configure it for you.
20+
21+
If you wish to enable or disable the MDX API on a specific Cube deployment, you may do so by going to "Settings" in the Cube Cloud sidebar, then "Configuration", and then toggling the "Enable MDX API" configuration flag switch.
22+
23+
To find your MDX API's credentials along with XMLA endpoint, go to "Settings" in the Cube Cloud sidebar, then "Connections and APIs"
24+
25+
## Using MDX API with Excel
26+
27+
Once MDX API is enabled, you can use it to connect to Cube from Excel. In Excel, go to the **Data tab**, click **Get Data** and select **From Database -> From Analysis Services**.
28+
29+
<InfoBox>
30+
Please note that only the [views](/reference/data-model/view) will be available for connections via MDX API
31+
</InfoBox>
32+
33+
The following section describes Excel-specific configuration options.
34+
35+
### Dimension hierarchies
36+
37+
MDX API supports dimension hierarchies. You can define multiple hierarchies.
38+
Each level in the hierarchy is a dimension from the view.
39+
40+
```yaml
41+
views:
42+
- name: orders_view
43+
description: "Data about orders, amount, count and breakdown by status and geography."
44+
meta:
45+
hierarchies:
46+
- name: "Geography"
47+
levels:
48+
- country
49+
- state
50+
- city
51+
```
52+
53+
### Measure groups
54+
55+
MDX API supports organizing measures into groups (folders). You can define measure groups in the view's schema file.
56+
57+
```yaml
58+
views:
59+
- name: orders_view
60+
description: "Data about orders, amount, count and breakdown by status and geography."
61+
meta:
62+
folders:
63+
- name: "Folder A"
64+
members:
65+
- total_amount
66+
- average_order_value
67+
- name: "Folder B"
68+
members:
69+
- completed_count
70+
- completed_percentage
71+
```
72+
73+
## Authentication and authorization
74+
75+
Authentication and authorization work the same as for the [SQL API](/product/apis-integrations/sql-api/security).

0 commit comments

Comments
 (0)