Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .cursor/rules/namings-rule.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ Make sure to use correct terms.
- **API**
- Embed APIs
- Core Data APIs
- SQL API
- DAX API
- REST (JSON) API (transitional name; previously "REST API", will eventually become "JSON API")
- GraphQL API
- Management APIs
- Orchestration API
- **Embedding**
Expand Down Expand Up @@ -93,6 +97,25 @@ Page naming inside the **Iframe embedding** group:
- Use **Dashboards**, **Analytics Chat**, **Creator Mode** (not "Embed a dashboard", "Embed Analytics Chat", etc.)
- Use **Private embedding**, **Signed embedding** for the auth-mode pages (the word "embedding" is part of the product term itself).

# Core Data API Naming

The Core Data APIs are: **SQL API**, **DAX API**, **REST (JSON) API**, and **GraphQL API**.

## REST (JSON) API

We are transitioning the name of our HTTP/JSON-based Core Data API:

- Previous name: **REST API**
- Current (transitional) name: **REST (JSON) API** — use this in all new and updated content
- Future name: **JSON API**

Guidance for the transitional period:

- In prose, link references, headings, navigation labels, and card titles, use **REST (JSON) API** in place of **REST API**.
- Do not change URL paths, route segments, file/directory names, code identifiers, env vars, or config option names (e.g., `/reference/core-data-apis/rest-api`, `rest-api/index.mdx`, the `rest` query format value, internal link slugs like `[ref-rest-api]`).
- Do not rewrite third-party UI literals where "REST API" is a verbatim label in another product (e.g., Retool's `"REST API"` resource type, Budibase's `"REST API"` data source). Quote them as the third-party tool spells them.
- Plural form ("REST APIs") is not currently used and should be avoided; refer to the API in the singular.

# Agent Terminology

Every [Deployment](#product-taxonomy) ships with **one agent** by default. The agent powers AI features (Analytics Chat, ad-hoc queries, etc.) and is configured per-deployment with rules, certified queries, and other customizations. Multi-agent (multiple agents per deployment) is also supported, but the documentation primarily covers the default single-agent setup; multi-agent docs will follow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Appsmith using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Appsmith using the [REST (JSON) API](/reference/rest-api).

For a Cube instance publicly available at a specific `HOST`, the REST API URL
For a Cube instance publicly available at a specific `HOST`, the REST (JSON) API URL
would be `HOST/cubejs-api/v1`. Please refer to the
[REST API page](/reference/rest-api) for details.
[REST (JSON) API page](/reference/rest-api) for details.

You will also need to generate a JSON Web Token that would be used to
authenticate requests to Cube.
Expand All @@ -42,7 +42,7 @@ won't expire soon.

### Create a new data source

Copy and paste the REST API URL and the Authorization token to create a new data
Copy and paste the REST (JSON) API URL and the Authorization token to create a new data
source in Appsmith.

<Frame>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Bubble using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Bubble using the [REST (JSON) API](/reference/rest-api).

For a Cube instance publicly available at a specific `HOST`, the REST API URL
For a Cube instance publicly available at a specific `HOST`, the REST (JSON) API URL
would be `HOST/cubejs-api/v1`. Please refer to the
[REST API page](/reference/rest-api) for details.
[REST (JSON) API page](/reference/rest-api) for details.

You will also need to generate a JSON Web Token that would be used to
authenticate requests to Cube.
Expand Down Expand Up @@ -64,7 +64,7 @@ all calls by setting `content-type` to `application/json`.

Click "Add another call".

Copy and paste the Cube REST API, including the `/load` path, in the API field.
Copy and paste the Cube REST (JSON) API, including the `/load` path, in the API field.
Make sure to select "Use as: Action", and use the `JSON` "data type" and "body
type".

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Budibase using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Budibase using the [REST (JSON) API](/reference/rest-api).

For a Cube instance publicly available at a specific `HOST`, the REST API URL
For a Cube instance publicly available at a specific `HOST`, the REST (JSON) API URL
would be `HOST/cubejs-api/v1`. Please refer to the
[REST API page](/reference/rest-api) for details.
[REST (JSON) API page](/reference/rest-api) for details.

You will also need to generate a JSON Web Token that would be used to
authenticate requests to Cube.
Expand All @@ -45,7 +45,7 @@ Create a new "REST API" data source in Budibase.
<img src="https://ucarecdn.com/381542a0-3d74-4ad6-9f3a-599be5d369f4/" />
</Frame>

Next, add a "Authorization" header for the REST API. Copy and paste Cube's
Next, add a "Authorization" header for the REST (JSON) API. Copy and paste Cube's
Authorization token.

<Frame>
Expand All @@ -56,7 +56,7 @@ Authorization token.

Click "+ Add Query".

Copy and paste the Cube REST API, including the `/load` path, in the API field.
Copy and paste the Cube REST (JSON) API, including the `/load` path, in the API field.
Make sure to select "POST" as the request.

<Frame>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,12 @@ Cube provides integration libraries for popular front-end frameworks:

All integrations above are powered by the following APIs. If you're a data
engineer, please explore the SQL API. If you're an application developer, check
out REST and GraphQL APIs.
out the REST (JSON) and GraphQL APIs.

<CardGroup cols={2}>
<Card title="SQL API" img="https://static.cube.dev/icons/sql.svg" href="/reference/sql-api">
</Card>
<Card title="REST API" img="https://static.cube.dev/icons/rest.svg" href="/reference/rest-api">
<Card title="REST (JSON) API" img="https://static.cube.dev/icons/rest.svg" href="/reference/rest-api">
</Card>
<Card title="GraphQL API" img="https://static.cube.dev/icons/graphql.svg" href="/reference/graphql-api">
</Card>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Klipfolio PowerMetrics using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Klipfolio PowerMetrics using the [REST (JSON) API](/reference/rest-api).

## Connecting in Klipfolio

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We're also providing an chat-based demo application (see source code on GitHub)

## Configuring the connection to Cube

The document loader connects to Cube using the [REST API][ref-rest-api], and will need a
The document loader connects to Cube using the [REST (JSON) API][ref-rest-api], and will need a
[JWT][ref-jwt] to authenticate.

If you're using Cube Cloud, you can retrieve these details from a deployment's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ detailed instructions.
## Connect from Cube Core

You can connect a Cube deployment to Observable using the [SQL API][ref-sql-api]
or the [REST API][ref-rest-api].
or the [REST (JSON) API][ref-rest-api].

In Cube Core, the SQL API is disabled by default. Enable it and [configure
the credentials](/reference/sql-api#configuration) to
Expand Down Expand Up @@ -76,11 +76,11 @@ You can also create a visualization of the executed SQL query.
/>
</div>

### Connecting via REST API
### Connecting via REST (JSON) API

For a Cube instance publicly available at a specific `HOST`, the REST API URL
For a Cube instance publicly available at a specific `HOST`, the REST (JSON) API URL
would be `HOST/cubejs-api/v1`. Please refer to the
[REST API page](/reference/rest-api) for details.
[REST (JSON) API page](/reference/rest-api) for details.

You will also need to generate a JSON Web Token that would be used to
authenticate requests to Cube.
Expand All @@ -89,7 +89,7 @@ Please check the [Security page](/embedding/authentication/jwt#generating-json-w
to learn how to generate a token. We suggest generating a long-lived JWT that
won't expire soon.

### Querying data with REST API
### Querying data with REST (JSON) API

First, add two generic **JavaScript** cells:

Expand All @@ -101,15 +101,15 @@ First, add two generic **JavaScript** cells:
/>
</div>

Next, copy Cube's REST API URL and the Authorization token and paste them into
Next, copy Cube's REST (JSON) API URL and the Authorization token and paste them into
their respective cells.

```javascript
cubeRestApi =
"https://thirsty-raccoon.aws-eu-central-1.cubecloudapp.dev/cubejs-api/v1/load";
```

Because the Cube REST API has the format of `HOST/cubejs-api/v1`, don't forget
Because the Cube REST (JSON) API has the format of `HOST/cubejs-api/v1`, don't forget
to add the `/load` endpoint to the end of the data source API.

```javascript
Expand Down Expand Up @@ -172,7 +172,7 @@ Next, click the play button on the top right of the cell.
/>
</div>

You can also create a visualization of the executed REST API request.
You can also create a visualization of the executed REST (JSON) API request.

<div style={{ textAlign: "center" }}>
<img
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Push.ai using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Push.ai using the [REST (JSON) API](/reference/rest-api).

## Connecting from Push.ai

### Adding an integration

Copy **REST API endpoint** and **API Secret** and paste them into Push.ai form for
Copy **REST (JSON) API endpoint** and **API Secret** and paste them into Push.ai form for
creating the Cube data source:

<Frame>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Retool using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Retool using the [REST (JSON) API](/reference/rest-api).

## Connecting from Retool

Expand All @@ -37,7 +37,7 @@ Create a new "REST API" resource in Retool.
<img src="https://ucarecdn.com/8a07d9ac-f33b-4aa1-8089-515694e56a63/" />
</Frame>

Next, copy and paste Cube's REST API URL and the Authorization token.
Next, copy and paste Cube's REST (JSON) API URL and the Authorization token.

<Frame>
<img src="https://ucarecdn.com/fdab9eaa-737b-4ef9-9e08-ad15aaa2fe29/" />
Expand All @@ -52,7 +52,7 @@ copy it from Cube’s Playground or compose manually.
Create a POST request, paste the JSON query in the **Body**. Make sure to add a
`query` parameter for your JSON query.

Because the Cube REST API has the format of `HOST/cubejs-api/v1`, don't forget
Because the Cube REST (JSON) API has the format of `HOST/cubejs-api/v1`, don't forget
to add the `/load` endpoint to the end of the data source API.

Next, hit Run.
Expand All @@ -67,8 +67,8 @@ Retool has an amazing feature where you can drag and drop UI components into the
dashboard. You can use this to add a tables, bar charts, and much more.

Because the name of the Retool query in the example is `OrdersByMonth`, using
the data binding curly brackets will populate the charts with data from the REST
API.
the data binding curly brackets will populate the charts with data from the
REST (JSON) API.

```handlebars
{{OrdersByMonth.data.data}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Steep
description: Pair Steep with Cube using Cloud integration steps or Core’s REST endpoint and API secret inside Steep’s data source form.
description: Pair Steep with Cube using Cloud integration steps or Core’s REST (JSON) API endpoint and API secret inside Steep’s data source form.
---

[Steep](https://steep.app) is a modern analytics platform powered by and
Expand All @@ -26,13 +26,13 @@ detailed instructions.

## Connect from Cube Core

You can connect a Cube deployment to Steep using the [REST API](/reference/rest-api).
You can connect a Cube deployment to Steep using the [REST (JSON) API](/reference/rest-api).

## Connecting from Steep

### Creating a data source

Copy **REST API endpoint** and **API Secret** and paste them into Steep form for
Copy **REST (JSON) API endpoint** and **API Secret** and paste them into Steep form for
creating the Cube data source:

<Frame>
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This approach ensures that all traffic between your applications and Cube Cloud
## Architecture

With private connectivity enabled, Cube Cloud exposes two AWS PrivateLink services:
- **HTTP API Service**: For REST API and GraphQL endpoints
- **HTTP API Service**: For REST (JSON) API and GraphQL endpoints
- **SQL API Service**: For PostgreSQL-compatible SQL interface connections

Your Cube deployment APIs are available on dedicated hostnames following this pattern:
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Usage is calculated per Cube Cloud deployment.

## Quotas

The [REST][ref-rest-api] and [GraphQL][ref-gql-api] APIs both have a standard
The [REST (JSON)][ref-rest-api] and [GraphQL][ref-gql-api] APIs both have a standard
quota of 100 requests per second per deployment; this can also go higher
for short bursts of traffic. These limits can be raised on request,
[contact support][cube-contact-us] for more details.
Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/admin/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ or using JavaScript, in a `cube.js` file in the root folder of a Cube project.
```python title="Python"
from cube import config

# Base path for the REST API
# Base path for the REST (JSON) API
config.base_path = '/cube-api'

# Inspect, modify, or restrict every query
Expand All @@ -95,7 +95,7 @@ def query_rewrite(query: dict, ctx: dict) -> dict:

```javascript title="JavaScript"
module.exports = {
// Base path for the REST API
// Base path for the REST (JSON) API
basePath: '/cube-api',

// Inspect, modify, or restrict every query
Expand Down
6 changes: 3 additions & 3 deletions docs-mintlify/admin/monitoring/query-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ to the left of any query.

Check the columns to see the details:
- **Query** column shows a representation of a query, similar to the
REST API [query format][ref-query-format]. In case of the SQL API, if the
query is not coercible to a REST API query, raw SQL is shown "as is."
REST (JSON) API [query format][ref-query-format]. In case of the SQL API, if the
query is not coercible to a REST (JSON) API query, raw SQL is shown "as is."
- **API** column shows the API type that was used to run the query:
REST API via HTTP transport, REST API via WebSockets, GraphQL API, or SQL API.
REST (JSON) API via HTTP transport, REST (JSON) API via WebSockets, GraphQL API, or SQL API.
- **Duration** column shows how long the query took.
- Bolt icon indicates the [cache type][ref-cache-types] that was used to
fulfill the query.
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/cube-core/getting-started/learn-more.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and how to effectively define metrics in your data models.
## Querying

Cube can be queried in a variety of ways. Explore how to use
[REST API](/reference/rest-api), [GraphQL API](/reference/graphql-api), and
[REST (JSON) API](/reference/rest-api), [GraphQL API](/reference/graphql-api), and
[SQL API](/reference/sql-api), or how to
[connect a BI or data visualization tool](/admin/connect-to-data/visualization-tools).

Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/cube-core/getting-started/query-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ connection instructions for specific BI tools:
<img src="https://ucarecdn.com/359af961-983f-41f2-829e-fc66910bfdb5/" />
</Frame>

Connectivity to data applications is enabled by the [REST API][ref-rest-api] and
Connectivity to data applications is enabled by the [REST (JSON) API][ref-rest-api] and
the [GraphQL API][ref-graphql-api] as well as [JavaScript
SDKs][ref-frontend-int]. Check the **Frontend Integrations** tab for
usage instructions for these APIs:
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@
]
},
{
"group": "REST API",
"group": "REST (JSON) API",
"root": "reference/core-data-apis/rest-api/index",
"pages": [
"reference/core-data-apis/rest-api/query-format",
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/docs/data-modeling/dynamic/jinja.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Jinja templates in Cube Core. Please [track this issue](https://github.com/cube-

You can also view the resulting data model in [Playground][ref-payground] and [Visual
Model][ref-visual-model]. Also, you can introspect the data model using the
[`/v1/meta` REST API endpoint][ref-meta-api].
[`/v1/meta` REST (JSON) API endpoint][ref-meta-api].

### Loops

Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/docs/explore-analyze/playground.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ in the result set as if there's no limit present.
### Pasting a query

You can also compose a new query by clicking on the _pencil_ button in the sidebar on the
left and pasting a [REST API][ref-rest-api] query or a [GraphQL API][ref-graphql-api]
left and pasting a [REST (JSON) API][ref-rest-api] query or a [GraphQL API][ref-graphql-api]
query from the clipboard and clicking **Apply**.

<Frame>
Expand Down Expand Up @@ -166,7 +166,7 @@ that Cube passes to an underlying data source driver later when executing the qu

## Copying API queries

View the queries for respective data APIs on the **SQL API**, **REST API**,
View the queries for respective data APIs on the **SQL API**, **REST (JSON) API**,
and **GraphQL API** tabs. Click **Copy** to put one of them into your clipboard.

<Frame>
Expand Down
Loading
Loading