Skip to content

docs(api-reference): api-review 2026-10-20 — document high_cardinality on RUM fields #1085

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
ysyneu merged 1 commit into from
Oct 20, 2026
Merged

docs(api-reference): api-review 2026-10-20 — document high_cardinality on RUM fields #1085

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
6 changes: 6 additions & 0 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21472,6 +21472,10 @@
"description": "Display group used to cluster fields in the console, such as `error`, `action` or `device`. Empty when the field has no group.",
"type": "string"
},
"high_cardinality": {
"description": "True when grouping by this field is restricted: event ID fields cannot be grouped at all, other high-cardinality fields only with count or sum.",
"type": "boolean"
},
"is_facet": {
"description": "True if value distribution counting is supported for this field.",
"type": "boolean"
Expand Down Expand Up @@ -21551,6 +21555,7 @@
"unit_name",
"edit_able",
"is_facet",
"high_cardinality",
"enum_values",
"scopes",
"status",
Expand Down Expand Up @@ -58461,6 +58466,7 @@
"field_key": "error_type",
"field_name": "Error Type",
"group": "error",
"high_cardinality": false,
"is_facet": true,
"queryable": true,
"scopes": [
Expand Down
6 changes: 6 additions & 0 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21472,6 +21472,10 @@
"description": "控制台中对字段分组展示所用的组名，如 `error`、`action`、`device`；无分组时为空。",
"type": "string"
},
"high_cardinality": {
"description": "为 true 时表示按该字段分组受限：事件 ID 类字段完全不可分组，其他高基数字段只能用 count 或 sum 聚合。",
"type": "boolean"
},
"is_facet": {
"description": "是否支持值分布统计查询。",
"type": "boolean"
Expand Down Expand Up @@ -21551,6 +21555,7 @@
"unit_name",
"edit_able",
"is_facet",
"high_cardinality",
"enum_values",
"scopes",
"status",
Expand Down Expand Up @@ -58461,6 +58466,7 @@
"field_key": "error_type",
"field_name": "Error Type",
"group": "error",
"high_cardinality": false,
"is_facet": true,
"queryable": true,
"scopes": [
Expand Down
6 changes: 6 additions & 0 deletions api-reference/rum.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,6 +1973,10 @@
"description": "Display group used to cluster fields in the console, such as `error`, `action` or `device`. Empty when the field has no group.",
"type": "string"
},
"high_cardinality": {
"description": "True when grouping by this field is restricted: event ID fields cannot be grouped at all, other high-cardinality fields only with count or sum.",
"type": "boolean"
},
"is_facet": {
"description": "True if value distribution counting is supported for this field.",
"type": "boolean"
Expand Down Expand Up @@ -2052,6 +2056,7 @@
"unit_name",
"edit_able",
"is_facet",
"high_cardinality",
"enum_values",
"scopes",
"status",
Expand Down Expand Up @@ -10463,6 +10468,7 @@
"field_key": "error_type",
"field_name": "Error Type",
"group": "error",
"high_cardinality": false,
"is_facet": true,
"queryable": true,
"scopes": [
Expand Down
6 changes: 6 additions & 0 deletions api-reference/rum.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,6 +1973,10 @@
"description": "控制台中对字段分组展示所用的组名，如 `error`、`action`、`device`；无分组时为空。",
"type": "string"
},
"high_cardinality": {
"description": "为 true 时表示按该字段分组受限：事件 ID 类字段完全不可分组，其他高基数字段只能用 count 或 sum 聚合。",
"type": "boolean"
},
"is_facet": {
"description": "是否支持值分布统计查询。",
"type": "boolean"
Expand Down Expand Up @@ -2052,6 +2056,7 @@
"unit_name",
"edit_able",
"is_facet",
"high_cardinality",
"enum_values",
"scopes",
"status",
Expand Down Expand Up @@ -10463,6 +10468,7 @@
"field_key": "error_type",
"field_name": "Error Type",
"group": "error",
"high_cardinality": false,
"is_facet": true,
"queryable": true,
"scopes": [
Expand Down
Loading