Skip to content

docs(api): /analytics/query 示例的 measure 拼写改为 revenue_sum,并写明合法拼写 (#6291) #6372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hotlong merged 1 commit into from
Aug 7, 2026
+21 −6
Merged

docs(api): /analytics/query 示例的 measure 拼写改为 revenue_sum,并写明合法拼写 (#6291) #6372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions content/docs/api/client-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ for the underlying endpoint contract.
// Semantic analytics query (cube-style)
const result = await client.analytics.query({
cube: 'account',
measures: ['revenue.sum', 'count'],
measures: ['revenue_sum', 'count'],
dimensions: ['industry'],
where: { status: 'active' },
limit: 100,
Expand All @@ -276,7 +276,7 @@ const meta = await client.analytics.meta('account');
// Dry-run a query to its generated SQL (POST /analytics/sql)
const explained = await client.analytics.explain({
cube: 'account',
measures: ['revenue.sum'],
measures: ['revenue_sum'],
});
```

Expand Down
23 changes: 19 additions & 4 deletions content/docs/api/data-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,13 +335,28 @@ Execute an analytics query.
```json
{
"cube": "account",
"measures": ["revenue.sum", "count"],
"measures": ["revenue_sum", "count"],
"dimensions": ["industry"],
"where": { "status": "active" },
"limit": 100
}
```

<Callout type="info">
**How to spell a measure.** A `measures` entry is either a measure the Cube **declares**,
or one of the inferred spellings: the bare `count` (`COUNT(*)`), or one of the object's
**own** field names plus an aggregation suffix — `_sum`, `_avg`, `_min`, `_max`,
`_count_distinct`. So "the sum of `revenue`" is `revenue_sum`.

A dot is legal **only** as the `<cube>.` qualifier: `account.revenue_sum` resolves to the
same measure as `revenue_sum` (the response column keeps whichever of the two you sent).
Any other dotted spelling — `revenue.sum`, `owner.amount_sum` — is refused with
`400 INVALID_FIELD` naming the spelling you sent, and nothing is executed: measures do not
traverse relationships, only dimensions do, so there is no related column for a dotted
measure to aggregate. To aggregate a related column, declare a Cube whose measure names it
in its own `sql`.
</Callout>

<Callout type="info">
Filtering uses the canonical Query DSL `where` object (the same MongoDB-style `FilterCondition` accepted by `find()`), not a `filters` array.
</Callout>
Expand All @@ -352,12 +367,12 @@ Filtering uses the canonical Query DSL `where` object (the same MongoDB-style `F
"success": true,
"data": {
"rows": [
{ "industry": "Technology", "revenue.sum": 150000, "count": 5 },
{ "industry": "Healthcare", "revenue.sum": 80000, "count": 3 }
{ "industry": "Technology", "revenue_sum": 150000, "count": 5 },
{ "industry": "Healthcare", "revenue_sum": 80000, "count": 3 }
],
"fields": [
{ "name": "industry", "type": "string", "label": "Industry" },
{ "name": "revenue.sum", "type": "number", "label": "Revenue Sum", "format": "$0,0" },
{ "name": "revenue_sum", "type": "number", "label": "Revenue Sum", "format": "$0,0" },
{ "name": "count", "type": "number", "label": "Count" }
],
"sql": "SELECT ..."
Expand Down
Loading