Skip to content

Commit b3dc0f5

Browse files
committed
docs(api): name fields[].nullLabel among the dataset answer's column members
Claude-Session: https://claude.ai/code/session_016qAuAwFXMw94v5vFqTVcw2 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 0c23275 commit b3dc0f5

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

‎content/docs/api/data-api.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ is executed. `POST /analytics/sql` refuses the same keys. To order by a member,
474474
<Callout type="info">
475475
**`fields[]` is the resolved presentation surface — read it first.** Each entry carries
476476
`name` and `type` and, when the producer declares them, `label`, `format`, `currency`,
477-
`percentScale`, `builtinAggregate` and `aggregate`: the optional members
477+
`percentScale`, `builtinAggregate`, `aggregate` and `nullLabel`: the optional members
478478
`AnalyticsResultResponseSchema` declares (`packages/spec/src/api/analytics.zod.ts`),
479479
mirrored member for member by `IAnalyticsService.query`'s `AnalyticsResult` and bound to
480480
it at compile time. Optional means a given column may omit them — read them defensively,
@@ -505,6 +505,12 @@ chart can tell a count from a sum. `builtinAggregate` is narrower: it is present
505505
when the measure has no `label`, to mark a header that is the server's default. Neither
506506
is set on a dimension column or a derived measure, and the cube query on this page
507507
carries neither.
508+
509+
A dimension column of a dataset answer carries `nullLabel` when its dataset dimension
510+
declares one: the name of the bucket of rows whose value for that dimension is null,
511+
resolved to the request's locale like `label`. A chart draws its null bucket under it
512+
instead of its own default. It is never set on a measure column, nor on the cube query
513+
on this page.
508514
</Callout>
509515

510516
### `GET /analytics/meta`

0 commit comments

Comments
 (0)