Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

feat(dashboards): stop batch widget tool schemas growing per widget type (#120112)

Thomas Obermüllere8c4b764f74f
diff --git a/.agents/skills/manage-dashboard-widgets/references/config-and-codegen.md b/.agents/skills/manage-dashboard-widgets/references/config-and-codegen.md
index b93f2fbf7ba3..5802dee342fc 100644
--- a/.agents/skills/manage-dashboard-widgets/references/config-and-codegen.md
+++ b/.agents/skills/manage-dashboard-widgets/references/config-and-codegen.md
@@ -12,7 +12,7 @@ Platform map (where files live): [architecture.md](architecture.md). Ship checkl
widget_specs/configs.py Pydantic *WidgetConfig per type (+ shared common.py)
│
├─► pydantic_openapi.py injects `model_json_schema()` into OpenAPI components (no DRF bridge)
- ├─► openapi.py polymorphic batch-add / PATCH / catalog OpenAPI (auto from WIDGET_SPECS)
+ ├─► openapi.py polymorphic PATCH / catalog OpenAPI, untyped batch config (auto from WIDGET_SPECS)
├─► registry.py WIDGET_SPECS manifest + validate_widget_config() (config, catalog labels, run_*)
└─► widget_catalog.py config_schema = model_json_schema() (for agents)
@@ -36,7 +36,7 @@ hogli build:openapi
| `common.py` | Shared `dateRange`, `widgetFilters`, `filterTestAccounts` |
| `registry.py` | `WIDGET_SPECS` + `validate_widget_config()` — per-type manifest (Pydantic model, `run_*`, scopes, RBAC, agent catalog labels/availability) |
| `widgets/config.py` | Query-time only — `resolve_filter_test_accounts(config, team)` (validation lives in Pydantic) |
-| `openapi.py` | Polymorphic OpenAPI for batch-add, catalog `config_schema`, dashboard PATCH — built from `WIDGET_SPECS` (no per-type hand wiring) |
+| `openapi.py` | Polymorphic OpenAPI for catalog `config_schema` and dashboard PATCH — built from `WIDGET_SPECS` (no per-type hand wiring) |
| `api/widget_openapi_serializers.py` | Stable re-export surface for `dashboard.api` imports (implementation in `widget_specs/openapi.py`) |
**Frontend config layering** (do not duplicate the full schema by hand):
@@ -71,7 +71,9 @@ Widget config Zod is product-scoped: `products/dashboards/frontend/bin/generate-
**New `widget_type`:** add a Pydantic `*WidgetConfig` in `widget_specs/configs.py` following the `*ListWidgetConfig` → `*WidgetConfig` naming convention — `build:widget-types` auto-derives Orval export names and fails if the OpenAPI slice is missing the model.
-**Schema gen blocker:** `build:openapi-schema` uses `--fail-on-warn`. Polymorphic per-type OpenAPI serializers each use a singleton `ChoiceField` for `widget_type`; `dashboard.py` uses the full `EXPECTED_WIDGET_TYPES` list — drf-spectacular enum names collide. When shipping a new type, add `{YourWidgetTypeEnum: ["your_widget_type"]}` to `ENUM_NAME_OVERRIDES` in `posthog/settings/web.py` — `hogli build:widget-types` and `test_widget_openapi_enums.py` fail if a registry type lacks an override; spectacular collision test fails if the override hash is wrong. Diagnostic: `python manage.py find_enum_collisions` (logic in `posthog/openapi/enum_collisions.py`). See `/improving-drf-endpoints`.
+**Batch tool schemas:** the batch-add and batch-update request schemas take `widget_type` and an untyped `config` object, so they stay the same size as widget types are added. Agents read each type's `config_schema` from the catalog, and `validate_widget_config()` rejects a bad config with a 400. Do not add per-type config variants back to these schemas.
+
+**Schema gen blocker:** `build:openapi-schema` uses `--fail-on-warn`. Per-type catalog entry serializers each use a singleton `ChoiceField` for `widget_type`; the OpenAPI fields that accept every type use the `DashboardWidgetType` choices class in `openapi.py` — drf-spectacular enum names collide otherwise. When shipping a new type, add it to `DashboardWidgetType` and add `{YourWidgetTypeEnum: ["your_widget_type"]}` to `ENUM_NAME_OVERRIDES` in `posthog/settings/web.py` — `hogli build:widget-types` and `test_widget_openapi_enums.py` fail if a registry type lacks an override; spectacular collision test fails if the override hash is wrong. Diagnostic: `python manage.py find_enum_collisions` (logic in `posthog/openapi/enum_collisions.py`). See `/improving-drf-endpoints`.
**Schema parity tests** (cheap drift guards — run when touching `widget_specs/`):
diff --git a/.agents/skills/manage-dashboard-widgets/references/mcp.md b/.agents/skills/manage-dashboard-widgets/references/mcp.md
index d7799dadbaee..0cd08bbf92b1 100644
--- a/.agents/skills/manage-dashboard-widgets/references/mcp.md
+++ b/.agents/skills/manage-dashboard-widgets/references/mcp.md
@@ -21,7 +21,7 @@ There is no dedicated single-tile create or per-tile `PATCH .../widgets/:tile_id
## Typical agent flow
-1. `dashboard-widget-catalog-list` — pick `widget_type`, build `config` from `config_schema` (same shape as batch-add / PATCH OpenAPI; includes `widgetFilters` when supported)
+1. `dashboard-widget-catalog-list` — pick `widget_type`, build `config` from `config_schema` (the batch tool schemas do not list config keys, so read them here; includes `widgetFilters` when supported)
2. `dashboard-widgets-batch-add` — add one or more tiles (up to 10 per request)
3. `dashboard-get` — confirm tile ID(s), widget row `id`, and layout
4. `dashboard-widgets-run` — fetch live widget data for `tile_ids` (private dashboards only — public/shared views do not call `run_widgets`)
diff --git a/products/dashboards/backend/api/test/test_dashboard_widgets.py b/products/dashboards/backend/api/test/test_dashboard_widgets.py
index 7292c8bdf8b0..4e44dd0c6e0f 100644
--- a/products/dashboards/backend/api/test/test_dashboard_widgets.py
+++ b/products/dashboards/backend/api/test/test_dashboard_widgets.py
@@ -1410,19 +1410,18 @@ class TestDashboardWidgetOpenApiSchema(APIBaseTest):
super().setUp()
self.dashboard_api = DashboardAPI(self.client, self.team, self.assertEqual)
- def test_add_dashboard_widget_openapi_schema_uses_widget_type_discriminator(self) -> None:
+ @parameterized.expand([("AddDashboardWidgetRequest",), ("UpdateDashboardWidgetRequest",)])
+ def test_batch_widget_openapi_schema_lists_every_type_and_leaves_config_untyped(self, component_name: str) -> None:
schema = SchemaGenerator().get_schema(request=None, public=True)
- component = schema["components"]["schemas"]["AddDashboardWidgetRequest"]
-
- assert component["discriminator"]["propertyName"] == "widget_type"
- assert set(component["discriminator"]["mapping"].keys()) == set(EXPECTED_WIDGET_TYPES)
-
- def test_update_dashboard_widget_openapi_schema_uses_widget_type_discriminator(self) -> None:
- schema = SchemaGenerator().get_schema(request=None, public=True)
- component = schema["components"]["schemas"]["UpdateDashboardWidgetRequest"]
-
- assert component["discriminator"]["propertyName"] == "widget_type"
- assert set(component["discriminator"]["mapping"].keys()) == set(EXPECTED_WIDGET_TYPES)
+ components = schema["components"]["schemas"]
+ properties = components[component_name]["properties"]
+ widget_type = properties["widget_type"]
+ widget_type_ref = widget_type.get("$ref") or widget_type["allOf"][0]["$ref"]
+ widget_type_enum = components[widget_type_ref.split("/")[-1]]["enum"]
+
+ assert set(widget_type_enum) == set(EXPECTED_WIDGET_TYPES)
+ assert properties["config"]["type"] == "object"
+ assert not {"oneOf", "anyOf", "allOf", "$ref", "properties"} & set(properties["config"])
def test_batch_add_rejects_unknown_widget_type(self) -> None:
dashboard_id, _ = self.dashboard_api.create_dashboard({"name": "dash"})
diff --git a/products/dashboards/backend/api/test/test_widget_openapi_enums.py b/products/dashboards/backend/api/test/test_widget_openapi_enums.py
index 30e6016b2122..e9ed06ff1c68 100644
--- a/products/dashboards/backend/api/test/test_widget_openapi_enums.py
+++ b/products/dashboards/backend/api/test/test_widget_openapi_enums.py
@@ -7,6 +7,7 @@ from drf_spectacular.generators import SchemaGenerator
from posthog.openapi.enum_collisions import EnumCollision, find_unresolved_enum_collisions
from products.dashboards.backend.widget_registry import EXPECTED_WIDGET_TYPES
+from products.dashboards.backend.widget_specs.openapi import DashboardWidgetType
_DASHBOARD_WIDGET_ENUM_COMPONENT_MARKERS = (
"Widget",
@@ -51,6 +52,9 @@ class TestWidgetOpenApiEnumOverrides:
"Add e.g. "
f'"{widget_type.replace("_", " ").title().replace(" ", "")}WidgetTypeEnum": ["{widget_type}"],'
)
+ assert set(DashboardWidgetType.values) == set(EXPECTED_WIDGET_TYPES), (
+ "DashboardWidgetType in widget_specs/openapi.py must list every registered widget type."
+ )
def test_dashboard_widget_openapi_has_no_unresolved_widget_type_enum_collisions(self) -> None:
schema = SchemaGenerator().get_schema(request=None, public=True)
diff --git a/products/dashboards/backend/widget_specs/openapi.py b/products/dashboards/backend/widget_specs/openapi.py
index bf116a313c89..0544bc6951f4 100644
--- a/products/dashboards/backend/widget_specs/openapi.py
+++ b/products/dashboards/backend/widget_specs/openapi.py
@@ -2,7 +2,9 @@ from __future__ import annotations
from typing import Any, cast
-from drf_spectacular.utils import PolymorphicProxySerializer, extend_schema_field
+from django.db import models
+
+from drf_spectacular.utils import PolymorphicProxySerializer, extend_schema_field, extend_schema_serializer
from pydantic import BaseModel
from rest_framework import serializers
@@ -37,6 +39,30 @@ WIDGET_BATCH_ADD_OPENAPI_HELP = (
)
+class DashboardWidgetType(models.TextChoices):
+ """Every registered widget type. test_widget_openapi_enums checks it against WIDGET_SPECS."""
+
+ ACTIVITY_EVENTS_LIST = "activity_events_list"
+ CANVAS_APP = "canvas_app"
+ CONVERSATIONS_RECENT_TICKETS = "conversations_recent_tickets"
+ ERROR_TRACKING_LIST = "error_tracking_list"
+ EXPERIMENT_RESULTS = "experiment_results"
+ EXPERIMENTS_LIST = "experiments_list"
+ LOGS_LIST = "logs_list"
+ NOTEBOOK_WIDGET = "notebook_widget"
+ SESSION_REPLAY_LIST = "session_replay_list"
+ SURVEY_RESULTS = "survey_results"
+
+
+# Batch tool schemas leave config untyped so they do not grow with each widget type.
+# validate_widget_config still checks every config against its widget type.
+WIDGET_CONFIG_BATCH_HELP = (
+ "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema "
+ "from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each "
+ "invalid field."
+)
+
+
def _config_model_openapi_prefix(config_model: type[BaseModel]) -> str:
name = config_model.__name__
if name.endswith("WidgetConfig"):
@@ -131,31 +157,11 @@ class _AddDashboardWidgetTileFieldsOpenApiSerializer(serializers.Serializer):
)
-def _build_openapi_serializers() -> tuple[
- dict[str, type[serializers.Serializer]],
- dict[str, type[serializers.Serializer]],
- dict[str, type[serializers.Serializer]],
-]:
- config_serializers: dict[str, type[serializers.Serializer]] = {}
- add_request_serializers: dict[str, type[serializers.Serializer]] = {}
+def _build_catalog_entry_serializers() -> dict[str, type[serializers.Serializer]]:
catalog_entry_serializers: dict[str, type[serializers.Serializer]] = {}
for widget_type, spec in WIDGET_SPECS.items():
- config_serializer = pydantic_stub_serializer(spec.config_model)
- config_serializers[widget_type] = config_serializer
-
prefix = _config_model_openapi_prefix(spec.config_model)
- add_request_serializers[widget_type] = type(
- f"{prefix}AddRequestOpenApiSerializer",
- (_AddDashboardWidgetTileFieldsOpenApiSerializer,),
- {
- "widget_type": serializers.ChoiceField(choices=[widget_type]),
- "config": pydantic_config_field(
- spec.config_model,
- help_text=f"Configuration for the {spec.label.lower()} widget.",
- ),
- },
- )
catalog_entry_serializers[widget_type] = type(
f"{prefix}CatalogEntryOpenApiSerializer",
(serializers.Serializer,),
@@ -169,7 +175,8 @@ def _build_openapi_serializers() -> tuple[
spec.config_model,
read_only=True,
help_text=(
- "OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas)."
+ "Config shape for this widget type. Build the config for the batch add and batch update "
+ "tools from it, because their schemas do not list config keys."
),
),
"required_product_access": serializers.CharField(required=False, allow_null=True),
@@ -183,12 +190,13 @@ def _build_openapi_serializers() -> tuple[
},
)
- return config_serializers, add_request_serializers, catalog_entry_serializers
+ return catalog_entry_serializers
-WIDGET_CONFIG_SERIALIZERS, _WIDGET_ADD_REQUEST_SERIALIZERS, _WIDGET_CATALOG_ENTRY_SERIALIZERS = (
- _build_openapi_serializers()
-)
+WIDGET_CONFIG_SERIALIZERS: dict[str, type[serializers.Serializer]] = {
+ widget_type: pydantic_stub_serializer(spec.config_model) for widget_type, spec in WIDGET_SPECS.items()
+}
+_WIDGET_CATALOG_ENTRY_SERIALIZERS = _build_catalog_entry_serializers()
DashboardWidgetConfigOpenApi = PolymorphicProxySerializer(
component_name="DashboardWidgetConfig",
@@ -204,11 +212,16 @@ class DashboardWidgetConfigField(serializers.JSONField):
pass
-AddDashboardWidgetRequestOpenApi = PolymorphicProxySerializer(
- component_name="AddDashboardWidgetRequest",
- serializers=cast("dict[str, Any]", _WIDGET_ADD_REQUEST_SERIALIZERS),
- resource_type_field_name="widget_type",
-)
+@extend_schema_serializer(component_name="AddDashboardWidgetRequest")
+class _AddDashboardWidgetRequestOpenApiSerializer(_AddDashboardWidgetTileFieldsOpenApiSerializer):
+ widget_type = serializers.ChoiceField(
+ choices=DashboardWidgetType.choices,
+ help_text="Widget type to add. Use dashboard-widget-catalog-list to pick one.",
+ )
+ config = serializers.DictField(child=serializers.JSONField(), help_text=WIDGET_CONFIG_BATCH_HELP)
+
+
+AddDashboardWidgetRequestOpenApi = _AddDashboardWidgetRequestOpenApiSerializer()
class _UpdateDashboardWidgetTileFieldsOpenApiSerializer(serializers.Serializer):
@@ -229,32 +242,24 @@ class _UpdateDashboardWidgetTileFieldsOpenApiSerializer(serializers.Serializer):
)
-def _build_update_request_serializers() -> dict[str, type[serializers.Serializer]]:
- update_request_serializers: dict[str, type[serializers.Serializer]] = {}
- for widget_type, spec in WIDGET_SPECS.items():
- prefix = _config_model_openapi_prefix(spec.config_model)
- update_request_serializers[widget_type] = type(
- f"{prefix}UpdateRequestOpenApiSerializer",
- (_UpdateDashboardWidgetTileFieldsOpenApiSerializer,),
- {
- "widget_type": serializers.ChoiceField(choices=[widget_type]),
- "config": pydantic_config_field(
- spec.config_model,
- required=False,
- help_text=f"New configuration for the {spec.label.lower()} widget. Omit to leave unchanged.",
- ),
- },
- )
- return update_request_serializers
-
+@extend_schema_serializer(component_name="UpdateDashboardWidgetRequest")
+class _UpdateDashboardWidgetRequestOpenApiSerializer(_UpdateDashboardWidgetTileFieldsOpenApiSerializer):
+ widget_type = serializers.ChoiceField(
+ choices=DashboardWidgetType.choices,
+ required=False,
+ help_text="The tile's widget type. It cannot be changed, so omit it or pass the current type.",
+ )
+ config = serializers.DictField(
+ child=serializers.JSONField(),
+ required=False,
+ help_text=(
+ f"{WIDGET_CONFIG_BATCH_HELP} Each top-level key you send replaces the stored value, and keys you "
+ "leave out stay as they are. Omit config to leave it unchanged."
+ ),
+ )
-_WIDGET_UPDATE_REQUEST_SERIALIZERS = _build_update_request_serializers()
-UpdateDashboardWidgetRequestOpenApi = PolymorphicProxySerializer(
- component_name="UpdateDashboardWidgetRequest",
- serializers=cast("dict[str, Any]", _WIDGET_UPDATE_REQUEST_SERIALIZERS),
- resource_type_field_name="widget_type",
-)
+UpdateDashboardWidgetRequestOpenApi = _UpdateDashboardWidgetRequestOpenApiSerializer()
WidgetCatalogEntryOpenApi = PolymorphicProxySerializer(
component_name="WidgetCatalogEntry",
@@ -276,7 +281,7 @@ class DashboardPatchWidgetOpenApiSerializer(serializers.Serializer):
help_text="Existing widget row ID when updating a widget tile via dashboard PATCH.",
)
widget_type = serializers.ChoiceField(
- choices=sorted(EXPECTED_WIDGET_TYPES),
+ choices=DashboardWidgetType.choices,
required=False,
help_text="Widget type identifier (cannot be changed on update).",
)
diff --git a/products/dashboards/frontend/generated/api.schemas.ts b/products/dashboards/frontend/generated/api.schemas.ts
index 734ccd9c178c..0490c03fab46 100644
--- a/products/dashboards/frontend/generated/api.schemas.ts
+++ b/products/dashboards/frontend/generated/api.schemas.ts
@@ -565,21 +565,20 @@ export const DashboardTileBadgeEnumApi = {
} as const
/**
- * * `activity_events_list` - activity_events_list
- * * `canvas_app` - canvas_app
- * * `conversations_recent_tickets` - conversations_recent_tickets
- * * `error_tracking_list` - error_tracking_list
- * * `experiment_results` - experiment_results
- * * `experiments_list` - experiments_list
- * * `logs_list` - logs_list
- * * `notebook_widget` - notebook_widget
- * * `session_replay_list` - session_replay_list
- * * `survey_results` - survey_results
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results
*/
-export type DashboardPatchWidgetOpenApiWidgetTypeEnumApi =
- (typeof DashboardPatchWidgetOpenApiWidgetTypeEnumApi)[keyof typeof DashboardPatchWidgetOpenApiWidgetTypeEnumApi]
+export type DashboardWidgetTypeEnumApi = (typeof DashboardWidgetTypeEnumApi)[keyof typeof DashboardWidgetTypeEnumApi]
-export const DashboardPatchWidgetOpenApiWidgetTypeEnumApi = {
+export const DashboardWidgetTypeEnumApi = {
ActivityEventsList: 'activity_events_list',
CanvasApp: 'canvas_app',
ConversationsRecentTickets: 'conversations_recent_tickets',
@@ -1049,17 +1048,17 @@ export interface DashboardPatchWidgetOpenApiApi {
id?: string
/** Widget type identifier (cannot be changed on update).
*
- * * `activity_events_list` - activity_events_list
- * * `canvas_app` - canvas_app
- * * `conversations_recent_tickets` - conversations_recent_tickets
- * * `error_tracking_list` - error_tracking_list
- * * `experiment_results` - experiment_results
- * * `experiments_list` - experiments_list
- * * `logs_list` - logs_list
- * * `notebook_widget` - notebook_widget
- * * `session_replay_list` - session_replay_list
- * * `survey_results` - survey_results */
- widget_type?: DashboardPatchWidgetOpenApiWidgetTypeEnumApi
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type?: DashboardWidgetTypeEnumApi
/** Widget-specific configuration. Shape depends on the tile's widget_type. */
config?: DashboardWidgetConfigApi
/**
@@ -9990,214 +9989,12 @@ export interface _TileLayoutsOpenApiApi {
xs?: _TileLayoutBoxOpenApiApi
}
-export type NotebookWidgetAddRequestOpenApiApiWidgetType =
- (typeof NotebookWidgetAddRequestOpenApiApiWidgetType)[keyof typeof NotebookWidgetAddRequestOpenApiApiWidgetType]
-
-export const NotebookWidgetAddRequestOpenApiApiWidgetType = {
- NotebookWidget: 'notebook_widget',
-} as const
-
-export interface NotebookWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: NotebookWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the notebook widget widget. */
- config: NotebookWidgetConfigApi
-}
-
-export type ActivityEventsListWidgetAddRequestOpenApiApiWidgetType =
- (typeof ActivityEventsListWidgetAddRequestOpenApiApiWidgetType)[keyof typeof ActivityEventsListWidgetAddRequestOpenApiApiWidgetType]
-
-export const ActivityEventsListWidgetAddRequestOpenApiApiWidgetType = {
- ActivityEventsList: 'activity_events_list',
-} as const
-
-export interface ActivityEventsListWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: ActivityEventsListWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the recent events widget. */
- config: ActivityEventsListWidgetConfigApi
-}
-
-export type ErrorTrackingListWidgetAddRequestOpenApiApiWidgetType =
- (typeof ErrorTrackingListWidgetAddRequestOpenApiApiWidgetType)[keyof typeof ErrorTrackingListWidgetAddRequestOpenApiApiWidgetType]
-
-export const ErrorTrackingListWidgetAddRequestOpenApiApiWidgetType = {
- ErrorTrackingList: 'error_tracking_list',
-} as const
-
-export interface ErrorTrackingListWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: ErrorTrackingListWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the top issues widget. */
- config: ErrorTrackingListWidgetConfigApi
-}
-
-export type SessionReplayListWidgetAddRequestOpenApiApiWidgetType =
- (typeof SessionReplayListWidgetAddRequestOpenApiApiWidgetType)[keyof typeof SessionReplayListWidgetAddRequestOpenApiApiWidgetType]
-
-export const SessionReplayListWidgetAddRequestOpenApiApiWidgetType = {
- SessionReplayList: 'session_replay_list',
-} as const
-
-export interface SessionReplayListWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: SessionReplayListWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the recent recordings widget. */
- config: SessionReplayListWidgetConfigApi
-}
-
-export type ExperimentsListWidgetAddRequestOpenApiApiWidgetType =
- (typeof ExperimentsListWidgetAddRequestOpenApiApiWidgetType)[keyof typeof ExperimentsListWidgetAddRequestOpenApiApiWidgetType]
-
-export const ExperimentsListWidgetAddRequestOpenApiApiWidgetType = {
- ExperimentsList: 'experiments_list',
-} as const
-
-export interface ExperimentsListWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: ExperimentsListWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the experiments list widget. */
- config: ExperimentsListWidgetConfigApi
-}
-
-export type ExperimentResultsWidgetAddRequestOpenApiApiWidgetType =
- (typeof ExperimentResultsWidgetAddRequestOpenApiApiWidgetType)[keyof typeof ExperimentResultsWidgetAddRequestOpenApiApiWidgetType]
-
-export const ExperimentResultsWidgetAddRequestOpenApiApiWidgetType = {
- ExperimentResults: 'experiment_results',
-} as const
-
-export interface ExperimentResultsWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: ExperimentResultsWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the experiment results widget. */
- config: ExperimentResultsWidgetConfigApi
-}
-
-export type SurveyResultsWidgetAddRequestOpenApiApiWidgetType =
- (typeof SurveyResultsWidgetAddRequestOpenApiApiWidgetType)[keyof typeof SurveyResultsWidgetAddRequestOpenApiApiWidgetType]
-
-export const SurveyResultsWidgetAddRequestOpenApiApiWidgetType = {
- SurveyResults: 'survey_results',
-} as const
-
-export interface SurveyResultsWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: SurveyResultsWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the survey results widget. */
- config: SurveyResultsWidgetConfigApi
-}
-
-export type LogsListWidgetAddRequestOpenApiApiWidgetType =
- (typeof LogsListWidgetAddRequestOpenApiApiWidgetType)[keyof typeof LogsListWidgetAddRequestOpenApiApiWidgetType]
-
-export const LogsListWidgetAddRequestOpenApiApiWidgetType = {
- LogsList: 'logs_list',
-} as const
-
-export interface LogsListWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: LogsListWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the recent logs widget. */
- config: LogsListWidgetConfigApi
-}
-
-export type ConversationsRecentTicketsWidgetAddRequestOpenApiApiWidgetType =
- (typeof ConversationsRecentTicketsWidgetAddRequestOpenApiApiWidgetType)[keyof typeof ConversationsRecentTicketsWidgetAddRequestOpenApiApiWidgetType]
-
-export const ConversationsRecentTicketsWidgetAddRequestOpenApiApiWidgetType = {
- ConversationsRecentTickets: 'conversations_recent_tickets',
-} as const
+/**
+ * Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field.
+ */
+export type AddDashboardWidgetRequestApiConfig = { [key: string]: unknown }
-export interface ConversationsRecentTicketsWidgetAddRequestOpenApiApi {
+export interface AddDashboardWidgetRequestApi {
/**
* Optional custom display name for the widget tile.
* @maxLength 400
@@ -10210,48 +10007,23 @@ export interface ConversationsRecentTicketsWidgetAddRequestOpenApiApi {
layouts?: _TileLayoutsOpenApiApi
/** Whether to show the description on the dashboard tile. */
show_description?: boolean
- widget_type: ConversationsRecentTicketsWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the recent tickets widget. */
- config: ConversationsRecentTicketsWidgetConfigApi
+ /** Widget type to add. Use dashboard-widget-catalog-list to pick one.
+ *
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type: DashboardWidgetTypeEnumApi
+ /** Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. */
+ config: AddDashboardWidgetRequestApiConfig
}
-export type CanvasAppWidgetAddRequestOpenApiApiWidgetType =
- (typeof CanvasAppWidgetAddRequestOpenApiApiWidgetType)[keyof typeof CanvasAppWidgetAddRequestOpenApiApiWidgetType]
-
-export const CanvasAppWidgetAddRequestOpenApiApiWidgetType = {
- CanvasApp: 'canvas_app',
-} as const
-
-export interface CanvasAppWidgetAddRequestOpenApiApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** Optional markdown description shown when show_description is enabled. */
- description?: string
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApiApi
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean
- widget_type: CanvasAppWidgetAddRequestOpenApiApiWidgetType
- /** Configuration for the canvas app widget. */
- config: CanvasAppWidgetConfigApi
-}
-
-export type AddDashboardWidgetRequestApi =
- | NotebookWidgetAddRequestOpenApiApi
- | ActivityEventsListWidgetAddRequestOpenApiApi
- | ErrorTrackingListWidgetAddRequestOpenApiApi
- | SessionReplayListWidgetAddRequestOpenApiApi
- | ExperimentsListWidgetAddRequestOpenApiApi
- | ExperimentResultsWidgetAddRequestOpenApiApi
- | SurveyResultsWidgetAddRequestOpenApiApi
- | LogsListWidgetAddRequestOpenApiApi
- | ConversationsRecentTicketsWidgetAddRequestOpenApiApi
- | CanvasAppWidgetAddRequestOpenApiApi
-
/**
* OpenAPI-only batch-add schema with widget_type-discriminated config shapes for agents.
*/
@@ -10269,198 +10041,12 @@ export interface AddDashboardWidgetsBatchResponseApi {
tiles: DashboardTileApi[]
}
-export type NotebookWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof NotebookWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof NotebookWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const NotebookWidgetUpdateRequestOpenApiApiWidgetType = {
- NotebookWidget: 'notebook_widget',
-} as const
-
-export interface NotebookWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: NotebookWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the notebook widget widget. Omit to leave unchanged. */
- config?: NotebookWidgetConfigApi
-}
-
-export type ActivityEventsListWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof ActivityEventsListWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof ActivityEventsListWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const ActivityEventsListWidgetUpdateRequestOpenApiApiWidgetType = {
- ActivityEventsList: 'activity_events_list',
-} as const
-
-export interface ActivityEventsListWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: ActivityEventsListWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the recent events widget. Omit to leave unchanged. */
- config?: ActivityEventsListWidgetConfigApi
-}
-
-export type ErrorTrackingListWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof ErrorTrackingListWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof ErrorTrackingListWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const ErrorTrackingListWidgetUpdateRequestOpenApiApiWidgetType = {
- ErrorTrackingList: 'error_tracking_list',
-} as const
-
-export interface ErrorTrackingListWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: ErrorTrackingListWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the top issues widget. Omit to leave unchanged. */
- config?: ErrorTrackingListWidgetConfigApi
-}
-
-export type SessionReplayListWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof SessionReplayListWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof SessionReplayListWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const SessionReplayListWidgetUpdateRequestOpenApiApiWidgetType = {
- SessionReplayList: 'session_replay_list',
-} as const
-
-export interface SessionReplayListWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: SessionReplayListWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the recent recordings widget. Omit to leave unchanged. */
- config?: SessionReplayListWidgetConfigApi
-}
-
-export type ExperimentsListWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof ExperimentsListWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof ExperimentsListWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const ExperimentsListWidgetUpdateRequestOpenApiApiWidgetType = {
- ExperimentsList: 'experiments_list',
-} as const
-
-export interface ExperimentsListWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: ExperimentsListWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the experiments list widget. Omit to leave unchanged. */
- config?: ExperimentsListWidgetConfigApi
-}
-
-export type ExperimentResultsWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof ExperimentResultsWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof ExperimentResultsWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const ExperimentResultsWidgetUpdateRequestOpenApiApiWidgetType = {
- ExperimentResults: 'experiment_results',
-} as const
-
-export interface ExperimentResultsWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: ExperimentResultsWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the experiment results widget. Omit to leave unchanged. */
- config?: ExperimentResultsWidgetConfigApi
-}
-
-export type SurveyResultsWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof SurveyResultsWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof SurveyResultsWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const SurveyResultsWidgetUpdateRequestOpenApiApiWidgetType = {
- SurveyResults: 'survey_results',
-} as const
-
-export interface SurveyResultsWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: SurveyResultsWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the survey results widget. Omit to leave unchanged. */
- config?: SurveyResultsWidgetConfigApi
-}
-
-export type LogsListWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof LogsListWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof LogsListWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const LogsListWidgetUpdateRequestOpenApiApiWidgetType = {
- LogsList: 'logs_list',
-} as const
-
-export interface LogsListWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: LogsListWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the recent logs widget. Omit to leave unchanged. */
- config?: LogsListWidgetConfigApi
-}
-
-export type ConversationsRecentTicketsWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof ConversationsRecentTicketsWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof ConversationsRecentTicketsWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const ConversationsRecentTicketsWidgetUpdateRequestOpenApiApiWidgetType = {
- ConversationsRecentTickets: 'conversations_recent_tickets',
-} as const
+/**
+ * Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged.
+ */
+export type UpdateDashboardWidgetRequestApiConfig = { [key: string]: unknown }
-export interface ConversationsRecentTicketsWidgetUpdateRequestOpenApiApi {
+export interface UpdateDashboardWidgetRequestApi {
/** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
tile_id: number
/**
@@ -10471,46 +10057,23 @@ export interface ConversationsRecentTicketsWidgetUpdateRequestOpenApiApi {
name?: string | null
/** New markdown description for the widget. Omit to leave unchanged. */
description?: string
- widget_type: ConversationsRecentTicketsWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the recent tickets widget. Omit to leave unchanged. */
- config?: ConversationsRecentTicketsWidgetConfigApi
+ /** The tile's widget type. It cannot be changed, so omit it or pass the current type.
+ *
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type?: DashboardWidgetTypeEnumApi
+ /** Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged. */
+ config?: UpdateDashboardWidgetRequestApiConfig
}
-export type CanvasAppWidgetUpdateRequestOpenApiApiWidgetType =
- (typeof CanvasAppWidgetUpdateRequestOpenApiApiWidgetType)[keyof typeof CanvasAppWidgetUpdateRequestOpenApiApiWidgetType]
-
-export const CanvasAppWidgetUpdateRequestOpenApiApiWidgetType = {
- CanvasApp: 'canvas_app',
-} as const
-
-export interface CanvasAppWidgetUpdateRequestOpenApiApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string
- widget_type: CanvasAppWidgetUpdateRequestOpenApiApiWidgetType
- /** New configuration for the canvas app widget. Omit to leave unchanged. */
- config?: CanvasAppWidgetConfigApi
-}
-
-export type UpdateDashboardWidgetRequestApi =
- | NotebookWidgetUpdateRequestOpenApiApi
- | ActivityEventsListWidgetUpdateRequestOpenApiApi
- | ErrorTrackingListWidgetUpdateRequestOpenApiApi
- | SessionReplayListWidgetUpdateRequestOpenApiApi
- | ExperimentsListWidgetUpdateRequestOpenApiApi
- | ExperimentResultsWidgetUpdateRequestOpenApiApi
- | SurveyResultsWidgetUpdateRequestOpenApiApi
- | LogsListWidgetUpdateRequestOpenApiApi
- | ConversationsRecentTicketsWidgetUpdateRequestOpenApiApi
- | CanvasAppWidgetUpdateRequestOpenApiApi
-
/**
* OpenAPI-only batch-update schema with widget_type-discriminated config shapes for agents.
*/
@@ -10614,7 +10177,7 @@ export interface NotebookWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: NotebookWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10635,7 +10198,7 @@ export interface ActivityEventsListWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ActivityEventsListWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10656,7 +10219,7 @@ export interface ErrorTrackingListWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ErrorTrackingListWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10677,7 +10240,7 @@ export interface SessionReplayListWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: SessionReplayListWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10698,7 +10261,7 @@ export interface ExperimentsListWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ExperimentsListWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10719,7 +10282,7 @@ export interface ExperimentResultsWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ExperimentResultsWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10740,7 +10303,7 @@ export interface SurveyResultsWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: SurveyResultsWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10761,7 +10324,7 @@ export interface LogsListWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: LogsListWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10782,7 +10345,7 @@ export interface ConversationsRecentTicketsWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ConversationsRecentTicketsWidgetConfigApi
/** @nullable */
required_product_access?: string | null
@@ -10803,7 +10366,7 @@ export interface CanvasAppWidgetCatalogEntryOpenApiApi {
group_label: string
label: string
description: string
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: CanvasAppWidgetConfigApi
/** @nullable */
required_product_access?: string | null
diff --git a/products/dashboards/frontend/generated/api.zod.ts b/products/dashboards/frontend/generated/api.zod.ts
index e90832f67d1b..f8e8e7f8e539 100644
--- a/products/dashboards/frontend/generated/api.zod.ts
+++ b/products/dashboards/frontend/generated/api.zod.ts
@@ -599,11 +599,11 @@ export const DashboardsPartialUpdateBody = /* @__PURE__ */ zod
'survey_results',
])
.describe(
- '\* `activity_events_list` - activity_events_list\n\* `canvas_app` - canvas_app\n\* `conversations_recent_tickets` - conversations_recent_tickets\n\* `error_tracking_list` - error_tracking_list\n\* `experiment_results` - experiment_results\n\* `experiments_list` - experiments_list\n\* `logs_list` - logs_list\n\* `notebook_widget` - notebook_widget\n\* `session_replay_list` - session_replay_list\n\* `survey_results` - survey_results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.optional()
.describe(
- 'Widget type identifier (cannot be changed on update).\n\n\* `activity_events_list` - activity_events_list\n\* `canvas_app` - canvas_app\n\* `conversations_recent_tickets` - conversations_recent_tickets\n\* `error_tracking_list` - error_tracking_list\n\* `experiment_results` - experiment_results\n\* `experiments_list` - experiments_list\n\* `logs_list` - logs_list\n\* `notebook_widget` - notebook_widget\n\* `session_replay_list` - session_replay_list\n\* `survey_results` - survey_results'
+ 'Widget type identifier (cannot be changed on update).\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
),
config: zod
.union([
@@ -1521,9 +1521,104 @@ export const DashboardsUpdateTextTileCreateBody = /* @__PURE__ */ zod.object({
/**
* Add multiple widget tiles to a dashboard in one atomic request.
*/
+export const dashboardsWidgetsBatchCreateBodyWidgetsItemNameMax = 400
+
+export const dashboardsWidgetsBatchCreateBodyWidgetsMax = 10
+
export const DashboardsWidgetsBatchCreateBody = /* @__PURE__ */ zod
- .record(zod.string(), zod.unknown())
- .describe('Deep\/recursive schema (opaque in Zod — use TypeScript types for full shape)')
+ .object({
+ widgets: zod
+ .array(
+ zod.object({
+ name: zod
+ .string()
+ .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNameMax)
+ .nullish()
+ .describe('Optional custom display name for the widget tile.'),
+ description: zod
+ .string()
+ .optional()
+ .describe('Optional markdown description shown when show_description is enabled.'),
+ layouts: zod
+ .object({
+ sm: zod
+ .object({
+ x: zod
+ .number()
+ .optional()
+ .describe('Column position in the dashboard grid (0-indexed).'),
+ y: zod
+ .number()
+ .optional()
+ .describe('Row position in the dashboard grid (0-indexed).'),
+ w: zod
+ .number()
+ .optional()
+ .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
+ h: zod.number().optional().describe('Height in grid rows.'),
+ })
+ .optional()
+ .describe('Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'),
+ xs: zod
+ .object({
+ x: zod
+ .number()
+ .optional()
+ .describe('Column position in the dashboard grid (0-indexed).'),
+ y: zod
+ .number()
+ .optional()
+ .describe('Row position in the dashboard grid (0-indexed).'),
+ w: zod
+ .number()
+ .optional()
+ .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
+ h: zod.number().optional().describe('Height in grid rows.'),
+ })
+ .optional()
+ .describe(
+ 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
+ ),
+ })
+ .optional()
+ .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
+ show_description: zod
+ .boolean()
+ .optional()
+ .describe('Whether to show the description on the dashboard tile.'),
+ widget_type: zod
+ .enum([
+ 'activity_events_list',
+ 'canvas_app',
+ 'conversations_recent_tickets',
+ 'error_tracking_list',
+ 'experiment_results',
+ 'experiments_list',
+ 'logs_list',
+ 'notebook_widget',
+ 'session_replay_list',
+ 'survey_results',
+ ])
+ .describe(
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ )
+ .describe(
+ 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ ),
+ config: zod
+ .record(zod.string(), zod.unknown())
+ .describe(
+ "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field."
+ ),
+ })
+ )
+ .min(1)
+ .max(dashboardsWidgetsBatchCreateBodyWidgetsMax)
+ .describe(
+ 'Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).'
+ ),
+ })
+ .describe('OpenAPI-only batch-add schema with widget_type-discriminated config shapes for agents.')
/**
* Update the settings of existing widgets in place, atomically — config, name, and description.
@@ -1534,80 +1629,7 @@ export const DashboardsWidgetsBatchCreateBody = /* @__PURE__ */ zod
* that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to
* remove one, use delete_tile.
*/
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOneNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOneConfigOneNotebookShortIdOneMax = 128
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitDefault = 25
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitMax = 50
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax = 4000
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax = 4000
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneMax = 20
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderByDefault = `occurrences`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneStatusDefault = `active`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderByDefault = `start_time`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderByDefault = `created_at`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneStatusDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSixNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitDefault = 50
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneOrderByDefault = `latest`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneWrapLinesDefault = false
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneTimezoneDefault = `UTC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneStatusDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneChannelDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneAssigneesMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchDefault = ``
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchMax = 200
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSavedViewIdOneMax = 12
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOnezeroNameMax = 400
+export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNameMax = 400
export const dashboardsUpdateWidgetsBatchBodyWidgetsMax = 10
@@ -1615,843 +1637,48 @@ export const DashboardsUpdateWidgetsBatchBody = /* @__PURE__ */ zod
.object({
widgets: zod
.array(
- zod.union([
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemOneNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['notebook_widget']),
- config: zod
- .object({
- notebookShortId: zod
- .union([
- zod
- .string()
- .min(1)
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemOneConfigOneNotebookShortIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Source notebook short ID.'),
- snapshotId: zod
- .union([zod.uuid(), zod.null()])
- .optional()
- .describe(
- "Immutable notebook widget snapshot. Add one from a notebook widget's menu."
- ),
- })
- .optional()
- .describe('New configuration for the notebook widget widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['activity_events_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitDefault)
- .describe('Maximum number of events to return.'),
- eventName: zod
- .union([zod.string().min(1), zod.null()])
- .optional()
- .describe('Limit the feed to a single event name. Omit or null for all events.'),
- properties: zod
- .union([
- zod
- .array(
- zod.object({
- key: zod
- .string()
- .min(1)
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax
- ),
- label: zod
- .union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax
- ),
- zod.null(),
- ])
- .optional(),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- type: zod.enum(['event', 'person']),
- value: zod
- .union([
- zod
- .array(
- zod.union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax
- ),
- zod.number(),
- zod.boolean(),
- ])
- )
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax
- ),
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax
- ),
- zod.number(),
- zod.boolean(),
- zod.null(),
- ])
- .optional(),
- })
- )
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Event and person property filters, matching Activity > Explore events.'),
- })
- .optional()
- .describe('New configuration for the recent events widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['error_tracking_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitDefault)
- .describe('Maximum number of issues to return.'),
- orderBy: zod
- .enum(['last_seen', 'first_seen', 'occurrences', 'users', 'sessions', 'severity'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderByDefault)
- .describe('Issue ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['archived', 'active', 'resolved', 'pending_release', 'suppressed', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneStatusDefault)
- .describe('Issue status filter.'),
- assignee: zod
- .union([
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- zod.null(),
- ])
- .optional()
- .describe('Filter by assignee ({type: user|role, id}). Omit for any assignee.'),
- })
- .optional()
- .describe('New configuration for the top issues widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['session_replay_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitDefault)
- .describe('Maximum number of recordings to return.'),
- orderBy: zod
- .enum([
- 'start_time',
- 'activity_score',
- 'recording_duration',
- 'duration',
- 'click_count',
- 'console_error_count',
- ])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderByDefault)
- .describe('Recording ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- savedFilterId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection.'
- ),
- collectionId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply.'
- ),
- })
- .optional()
- .describe('New configuration for the recent recordings widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['experiments_list']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitDefault)
- .describe('Maximum number of experiments to return.'),
- orderBy: zod
- .enum(['created_at', 'name', 'start_date'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderByDefault)
- .describe('Experiment list sort column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['draft', 'running', 'paused', 'exposure_frozen', 'stopped', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneStatusDefault)
- .describe('Experiment status filter.'),
- createdBy: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe('Filter by creator (user id). Omit for any creator.'),
- })
- .optional()
- .describe('New configuration for the experiments list widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSixNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['experiment_results']),
- config: zod
- .object({
- experimentId: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe(
- 'Experiment to show results for. Null until the user picks one in the widget settings.'
- ),
- })
- .optional()
- .describe('New configuration for the experiment results widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['survey_results']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional()
- .describe("Null or omitted means all time (the survey's full lifetime)."),
- surveyId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'Survey to show performance stats and recent responses for. Null until the user picks one.'
- ),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitDefault)
- .describe('Maximum number of recent responses to return.'),
- })
- .optional()
- .describe('New configuration for the survey results widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['logs_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitDefault)
- .describe('Maximum number of log lines to return.'),
- orderBy: zod
- .enum(['latest', 'earliest'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneOrderByDefault)
- .describe('Sort by newest (latest) or oldest (earliest) first.'),
- severityLevels: zod
- .array(zod.enum(['trace', 'debug', 'info', 'warn', 'error', 'fatal']))
- .optional()
- .describe('Only show logs at these severity levels. Empty shows all levels.'),
- serviceNames: zod
- .array(zod.string())
- .optional()
- .describe('Only show logs from these services. Empty shows all services.'),
- wrapLines: zod
- .boolean()
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneWrapLinesDefault)
- .describe('Wrap long log lines instead of truncating them to a single row.'),
- timezone: zod
- .enum(['UTC', 'local'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneTimezoneDefault)
- .describe("Render log timestamps in UTC or in each viewer's local timezone."),
- savedViewId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply.'
- ),
- })
- .optional()
- .describe('New configuration for the recent logs widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['conversations_recent_tickets']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitDefault)
- .describe('Maximum number of tickets to return.'),
- status: zod
- .enum(['new', 'open', 'pending', 'on_hold', 'resolved', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneStatusDefault)
- .describe('Ticket status filter.'),
- priorities: zod
- .array(zod.enum(['low', 'medium', 'high', 'critical']))
- .optional()
- .describe('Only show tickets with these priorities. Empty shows all priorities.'),
- channel: zod
- .enum(['widget', 'email', 'slack', 'teams', 'github', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneChannelDefault)
- .describe('Ticket channel filter.'),
- assignees: zod
- .array(
- zod.union([
- zod.enum(['me', 'unassigned']),
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- ])
- )
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneAssigneesMax)
- .optional()
- .describe(
- "Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees."
- ),
- search: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchDefault)
- .describe(
- 'Search requester name or email, ticket subject, message text, or ticket number.'
- ),
- savedViewId: zod
- .union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSavedViewIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe(
- 'short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit.'
- ),
- })
- .optional()
- .describe('New configuration for the recent tickets widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemOnezeroNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['canvas_app']),
- config: zod
- .object({
- canvasId: zod
- .union([zod.uuid(), zod.null()])
- .optional()
- .describe(
- 'Canvas to render in the tile. Null until the user picks one in the widget settings.'
- ),
- })
- .optional()
- .describe('New configuration for the canvas app widget. Omit to leave unchanged.'),
- }),
- ])
+ zod.object({
+ tile_id: zod
+ .number()
+ .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
+ name: zod
+ .string()
+ .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNameMax)
+ .nullish()
+ .describe(
+ 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
+ ),
+ description: zod
+ .string()
+ .optional()
+ .describe('New markdown description for the widget. Omit to leave unchanged.'),
+ widget_type: zod
+ .enum([
+ 'activity_events_list',
+ 'canvas_app',
+ 'conversations_recent_tickets',
+ 'error_tracking_list',
+ 'experiment_results',
+ 'experiments_list',
+ 'logs_list',
+ 'notebook_widget',
+ 'session_replay_list',
+ 'survey_results',
+ ])
+ .describe(
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ )
+ .optional()
+ .describe(
+ "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
+ ),
+ config: zod
+ .record(zod.string(), zod.unknown())
+ .optional()
+ .describe(
+ "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged."
+ ),
+ })
)
.min(1)
.max(dashboardsUpdateWidgetsBatchBodyWidgetsMax)
diff --git a/products/dashboards/mcp/tools.yaml b/products/dashboards/mcp/tools.yaml
index fb12f0b84536..73e4a1bf3b3d 100644
--- a/products/dashboards/mcp/tools.yaml
+++ b/products/dashboards/mcp/tools.yaml
@@ -579,11 +579,12 @@ tools:
description: >
Add widget tiles to a dashboard atomically via POST .../widgets/batch/ (1–10 tiles). Call
dashboard-widget-catalog-list first for valid widget_type values and config_schema. Pass `widgets` as an
- array of payloads (widget_type, config, optional name, description, layouts). Config shape is per
- widget_type (see catalog hints); widgetFilters when supported is a map of filter id to property filter
- entries. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts are
- omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new tiles —
- to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).
+ array of payloads (widget_type, config, optional name, description, layouts). This schema does not list
+ config keys: build each config from the config_schema of its widget_type in the catalog. widgetFilters, when
+ supported, is a map of filter id to property filter entries. An invalid config returns a 400 that names each
+ invalid field. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts
+ are omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new
+ tiles — to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).
param_overrides:
id:
cast: string-int
@@ -602,11 +603,11 @@ tools:
Update the settings of existing widgets in place atomically (1–10), without delete-and-re-add. Edits widget
settings only — `config`, `name`, and `description`. Pass `widgets` as an array of payloads, each identified
by its DashboardTile `tile_id` (use dashboard-get to look up widget tile IDs) plus the settings to change.
- Only the fields you provide per widget are updated; omitted fields are left unchanged. Optionally pass
- `widget_type` to get the typed config shape; widget_type is immutable. Config shape is per widget_type — see
- dashboard-widget-catalog-list. All updates succeed or fail together. Tile placement (layout,
- show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles for that. To add new
- widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.
+ Only the fields you provide per widget are updated; omitted fields are left unchanged. A config update
+ replaces only the top-level keys you send. This schema does not list config keys: read the config_schema of
+ the tile's widget_type from dashboard-widget-catalog-list. All updates succeed or fail together. Tile
+ placement (layout, show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles
+ for that. To add new widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.
param_overrides:
id:
cast: string-int
diff --git a/products/desktop/packages/api-client/src/generated.ts b/products/desktop/packages/api-client/src/generated.ts
index 96ec59284877..eab5e774172c 100644
--- a/products/desktop/packages/api-client/src/generated.ts
+++ b/products/desktop/packages/api-client/src/generated.ts
@@ -6380,18 +6380,18 @@ export namespace Schemas {
*/
export type DashboardTileBadgeEnum = "winner" | "cheeky-hog";
/**
- * * `activity_events_list` - activity_events_list
- * * `canvas_app` - canvas_app
- * * `conversations_recent_tickets` - conversations_recent_tickets
- * * `error_tracking_list` - error_tracking_list
- * * `experiment_results` - experiment_results
- * * `experiments_list` - experiments_list
- * * `logs_list` - logs_list
- * * `notebook_widget` - notebook_widget
- * * `session_replay_list` - session_replay_list
- * * `survey_results` - survey_results
- */
- export type DashboardPatchWidgetOpenApiWidgetTypeEnum =
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results
+ */
+ export type DashboardWidgetTypeEnum =
| "activity_events_list"
| "canvas_app"
| "conversations_recent_tickets"
@@ -6550,7 +6550,7 @@ export namespace Schemas {
| CanvasAppWidgetConfig;
export type DashboardPatchWidgetOpenApi = Partial<{
id: string;
- widget_type: DashboardPatchWidgetOpenApiWidgetTypeEnum;
+ widget_type: DashboardWidgetTypeEnum;
config: DashboardWidgetConfig;
name: string | null;
description: string;
diff --git a/services/mcp/schema/generated-tool-definitions.json b/services/mcp/schema/generated-tool-definitions.json
index 49768cba2ee3..58c3700680fc 100644
--- a/services/mcp/schema/generated-tool-definitions.json
+++ b/services/mcp/schema/generated-tool-definitions.json
@@ -3915,7 +3915,7 @@
}
},
"dashboard-widgets-batch-add": {
- "description": "Add widget tiles to a dashboard atomically via POST .../widgets/batch/ (1–10 tiles). Call dashboard-widget-catalog-list first for valid widget_type values and config_schema. Pass `widgets` as an array of payloads (widget_type, config, optional name, description, layouts). Config shape is per widget_type (see catalog hints); widgetFilters when supported is a map of filter id to property filter entries. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts are omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new tiles — to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).",
+ "description": "Add widget tiles to a dashboard atomically via POST .../widgets/batch/ (1–10 tiles). Call dashboard-widget-catalog-list first for valid widget_type values and config_schema. Pass `widgets` as an array of payloads (widget_type, config, optional name, description, layouts). This schema does not list config keys: build each config from the config_schema of its widget_type in the catalog. widgetFilters, when supported, is a map of filter id to property filter entries. An invalid config returns a 400 that names each invalid field. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts are omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new tiles — to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).",
"category": "Dashboards",
"feature": "dashboards",
"summary": "Add dashboard widgets",
@@ -3930,7 +3930,7 @@
}
},
"dashboard-widgets-batch-update": {
- "description": "Update the settings of existing widgets in place atomically (1–10), without delete-and-re-add. Edits widget settings only — `config`, `name`, and `description`. Pass `widgets` as an array of payloads, each identified by its DashboardTile `tile_id` (use dashboard-get to look up widget tile IDs) plus the settings to change. Only the fields you provide per widget are updated; omitted fields are left unchanged. Optionally pass `widget_type` to get the typed config shape; widget_type is immutable. Config shape is per widget_type — see dashboard-widget-catalog-list. All updates succeed or fail together. Tile placement (layout, show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles for that. To add new widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.",
+ "description": "Update the settings of existing widgets in place atomically (1–10), without delete-and-re-add. Edits widget settings only — `config`, `name`, and `description`. Pass `widgets` as an array of payloads, each identified by its DashboardTile `tile_id` (use dashboard-get to look up widget tile IDs) plus the settings to change. Only the fields you provide per widget are updated; omitted fields are left unchanged. A config update replaces only the top-level keys you send. This schema does not list config keys: read the config_schema of the tile's widget_type from dashboard-widget-catalog-list. All updates succeed or fail together. Tile placement (layout, show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles for that. To add new widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.",
"category": "Dashboards",
"feature": "dashboards",
"summary": "Update dashboard widget settings",
diff --git a/services/mcp/schema/tool-definitions-all.json b/services/mcp/schema/tool-definitions-all.json
index 3d4d920b6bf8..1be43b15cf4a 100644
--- a/services/mcp/schema/tool-definitions-all.json
+++ b/services/mcp/schema/tool-definitions-all.json
@@ -3930,7 +3930,7 @@
}
},
"dashboard-widgets-batch-add": {
- "description": "Add widget tiles to a dashboard atomically via POST .../widgets/batch/ (1–10 tiles). Call dashboard-widget-catalog-list first for valid widget_type values and config_schema. Pass `widgets` as an array of payloads (widget_type, config, optional name, description, layouts). Config shape is per widget_type (see catalog hints); widgetFilters when supported is a map of filter id to property filter entries. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts are omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new tiles — to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).",
+ "description": "Add widget tiles to a dashboard atomically via POST .../widgets/batch/ (1–10 tiles). Call dashboard-widget-catalog-list first for valid widget_type values and config_schema. Pass `widgets` as an array of payloads (widget_type, config, optional name, description, layouts). This schema does not list config keys: build each config from the config_schema of its widget_type in the catalog. widgetFilters, when supported, is a map of filter id to property filter entries. An invalid config returns a 400 that names each invalid field. For a single tile, pass a one-element `widgets` array. Tiles stack at the bottom when layouts are omitted. Returns all created tiles; use dashboard-widgets-run to fetch live data. This only adds new tiles — to edit existing widget tiles, use dashboard-widgets-batch-update (no delete-and-re-add needed).",
"category": "Dashboards",
"feature": "dashboards",
"summary": "Add dashboard widgets",
@@ -3945,7 +3945,7 @@
}
},
"dashboard-widgets-batch-update": {
- "description": "Update the settings of existing widgets in place atomically (1–10), without delete-and-re-add. Edits widget settings only — `config`, `name`, and `description`. Pass `widgets` as an array of payloads, each identified by its DashboardTile `tile_id` (use dashboard-get to look up widget tile IDs) plus the settings to change. Only the fields you provide per widget are updated; omitted fields are left unchanged. Optionally pass `widget_type` to get the typed config shape; widget_type is immutable. Config shape is per widget_type — see dashboard-widget-catalog-list. All updates succeed or fail together. Tile placement (layout, show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles for that. To add new widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.",
+ "description": "Update the settings of existing widgets in place atomically (1–10), without delete-and-re-add. Edits widget settings only — `config`, `name`, and `description`. Pass `widgets` as an array of payloads, each identified by its DashboardTile `tile_id` (use dashboard-get to look up widget tile IDs) plus the settings to change. Only the fields you provide per widget are updated; omitted fields are left unchanged. A config update replaces only the top-level keys you send. This schema does not list config keys: read the config_schema of the tile's widget_type from dashboard-widget-catalog-list. All updates succeed or fail together. Tile placement (layout, show_description) is not changed here — use dashboard-update or dashboard-reorder-tiles for that. To add new widgets, use dashboard-widgets-batch-add; to remove one, use dashboard-delete-tile.",
"category": "Dashboards",
"feature": "dashboards",
"summary": "Update dashboard widget settings",
diff --git a/services/mcp/schema/tool-inputs.json b/services/mcp/schema/tool-inputs.json
index 75d8fecc32ca..a140888687e0 100644
--- a/services/mcp/schema/tool-inputs.json
+++ b/services/mcp/schema/tool-inputs.json
@@ -163,24 +163,29 @@
"type": "object",
"properties": {
"sm": {
+ "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
"type": "object",
"properties": {
"x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"h": {
+ "description": "Height in grid rows.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
@@ -188,24 +193,29 @@
}
},
"xs": {
+ "description": "Layout for the small (mobile) breakpoint. The grid is 1 column wide.",
"type": "object",
"properties": {
"x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"h": {
+ "description": "Height in grid rows.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
diff --git a/services/mcp/src/api/generated.ts b/services/mcp/src/api/generated.ts
index da9dcd37d594..13bc0ec4e9d8 100644
--- a/services/mcp/src/api/generated.ts
+++ b/services/mcp/src/api/generated.ts
@@ -4888,31 +4888,13 @@ export namespace Schemas {
readonly status: MetricsRecalculationStatusEnum;
}
- export type ActivityEventsListWidgetAddRequestOpenApiWidgetType = typeof ActivityEventsListWidgetAddRequestOpenApiWidgetType[keyof typeof ActivityEventsListWidgetAddRequestOpenApiWidgetType];
+ export type ActivityEventsListWidgetCatalogEntryOpenApiWidgetType = typeof ActivityEventsListWidgetCatalogEntryOpenApiWidgetType[keyof typeof ActivityEventsListWidgetCatalogEntryOpenApiWidgetType];
- export const ActivityEventsListWidgetAddRequestOpenApiWidgetType = {
+ export const ActivityEventsListWidgetCatalogEntryOpenApiWidgetType = {
ActivityEventsList: 'activity_events_list',
} as const;
- export interface _TileLayoutBoxOpenApi {
- /** Column position in the dashboard grid (0-indexed). */
- x?: number;
- /** Row position in the dashboard grid (0-indexed). */
- y?: number;
- /** Width in grid columns. The desktop grid is 12 columns wide. */
- w?: number;
- /** Height in grid rows. */
- h?: number;
- }
-
- export interface _TileLayoutsOpenApi {
- /** Layout for the standard (desktop) breakpoint. The grid is 12 columns wide. */
- sm?: _TileLayoutBoxOpenApi;
- /** Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders. */
- xs?: _TileLayoutBoxOpenApi;
- }
-
export type WidgetDateRangeDateFrom = typeof WidgetDateRangeDateFrom[keyof typeof WidgetDateRangeDateFrom] | null;
@@ -4981,38 +4963,13 @@ export namespace Schemas {
properties?: ActivityEventsPropertyFilter[] | null;
}
- export interface ActivityEventsListWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: ActivityEventsListWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the recent events widget. */
- config: ActivityEventsListWidgetConfig;
- }
-
- export type ActivityEventsListWidgetCatalogEntryOpenApiWidgetType = typeof ActivityEventsListWidgetCatalogEntryOpenApiWidgetType[keyof typeof ActivityEventsListWidgetCatalogEntryOpenApiWidgetType];
-
-
- export const ActivityEventsListWidgetCatalogEntryOpenApiWidgetType = {
- ActivityEventsList: 'activity_events_list',
- } as const;
-
export interface ActivityEventsListWidgetCatalogEntryOpenApi {
widget_type: ActivityEventsListWidgetCatalogEntryOpenApiWidgetType;
group_id: string;
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ActivityEventsListWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -5030,29 +4987,6 @@ export namespace Schemas {
ActivityEventsList: 'activity_events_list',
} as const;
- export type ActivityEventsListWidgetUpdateRequestOpenApiWidgetType = typeof ActivityEventsListWidgetUpdateRequestOpenApiWidgetType[keyof typeof ActivityEventsListWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const ActivityEventsListWidgetUpdateRequestOpenApiWidgetType = {
- ActivityEventsList: 'activity_events_list',
- } as const;
-
- export interface ActivityEventsListWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: ActivityEventsListWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the recent events widget. Omit to leave unchanged. */
- config?: ActivityEventsListWidgetConfig;
- }
-
/**
* * `awaiting_input` - awaiting_input
* * `completed` - completed
@@ -7651,543 +7585,58 @@ export namespace Schemas {
GithubPr: 'github_pr',
} as const;
- export type NotebookWidgetAddRequestOpenApiWidgetType = typeof NotebookWidgetAddRequestOpenApiWidgetType[keyof typeof NotebookWidgetAddRequestOpenApiWidgetType];
-
-
- export const NotebookWidgetAddRequestOpenApiWidgetType = {
- NotebookWidget: 'notebook_widget',
- } as const;
-
- export interface NotebookWidgetConfig {
- /** Source notebook short ID. */
- notebookShortId?: string | null;
- /** Immutable notebook widget snapshot. Add one from a notebook widget's menu. */
- snapshotId?: string | null;
- }
-
- export interface NotebookWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: NotebookWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the notebook widget widget. */
- config: NotebookWidgetConfig;
- }
-
- export type ErrorTrackingListWidgetAddRequestOpenApiWidgetType = typeof ErrorTrackingListWidgetAddRequestOpenApiWidgetType[keyof typeof ErrorTrackingListWidgetAddRequestOpenApiWidgetType];
-
-
- export const ErrorTrackingListWidgetAddRequestOpenApiWidgetType = {
- ErrorTrackingList: 'error_tracking_list',
- } as const;
-
- export type ErrorTrackingOrderBy = typeof ErrorTrackingOrderBy[keyof typeof ErrorTrackingOrderBy];
-
-
- export const ErrorTrackingOrderBy = {
- LastSeen: 'last_seen',
- FirstSeen: 'first_seen',
- Occurrences: 'occurrences',
- Users: 'users',
- Sessions: 'sessions',
- Severity: 'severity',
- } as const;
-
/**
- * Sort direction for orderBy.
+ * Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field.
*/
- export type ErrorTrackingListWidgetConfigOrderDirection = typeof ErrorTrackingListWidgetConfigOrderDirection[keyof typeof ErrorTrackingListWidgetConfigOrderDirection];
+ export type AddDashboardWidgetRequestConfig = { [key: string]: unknown };
-
- export const ErrorTrackingListWidgetConfigOrderDirection = {
- Asc: 'ASC',
- Desc: 'DESC',
- } as const;
-
- /**
- * Issue status filter.
- */
- export type ErrorTrackingListWidgetConfigStatus = typeof ErrorTrackingListWidgetConfigStatus[keyof typeof ErrorTrackingListWidgetConfigStatus];
-
-
- export const ErrorTrackingListWidgetConfigStatus = {
- Archived: 'archived',
- Active: 'active',
- Resolved: 'resolved',
- PendingRelease: 'pending_release',
- Suppressed: 'suppressed',
- All: 'all',
- } as const;
-
- export type WidgetAssigneeFilterType = typeof WidgetAssigneeFilterType[keyof typeof WidgetAssigneeFilterType];
-
-
- export const WidgetAssigneeFilterType = {
- User: 'user',
- Role: 'role',
- } as const;
-
- export interface WidgetAssigneeFilter {
- id: string | number;
- type: WidgetAssigneeFilterType;
- }
-
- export type ErrorTrackingListWidgetConfigWidgetFilters = {[key: string]: WidgetFilterEntry} | null;
-
- export interface ErrorTrackingListWidgetConfig {
- dateRange?: WidgetDateRange | null;
- filterTestAccounts?: boolean | null;
- widgetFilters?: ErrorTrackingListWidgetConfigWidgetFilters;
- /**
- * Maximum number of issues to return.
- * @minimum 1
- * @maximum 25
- */
- limit?: number;
- /** Issue ranking column. */
- orderBy?: ErrorTrackingOrderBy;
- /** Sort direction for orderBy. */
- orderDirection?: ErrorTrackingListWidgetConfigOrderDirection;
- /** Issue status filter. */
- status?: ErrorTrackingListWidgetConfigStatus;
- /** Filter by assignee ({type: user|role, id}). Omit for any assignee. */
- assignee?: WidgetAssigneeFilter | null;
- }
-
- export interface ErrorTrackingListWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: ErrorTrackingListWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the top issues widget. */
- config: ErrorTrackingListWidgetConfig;
- }
-
- export type SessionReplayListWidgetAddRequestOpenApiWidgetType = typeof SessionReplayListWidgetAddRequestOpenApiWidgetType[keyof typeof SessionReplayListWidgetAddRequestOpenApiWidgetType];
-
-
- export const SessionReplayListWidgetAddRequestOpenApiWidgetType = {
- SessionReplayList: 'session_replay_list',
- } as const;
-
- /**
- * Recording ranking column.
- */
- export type SessionReplayListWidgetConfigOrderBy = typeof SessionReplayListWidgetConfigOrderBy[keyof typeof SessionReplayListWidgetConfigOrderBy];
-
-
- export const SessionReplayListWidgetConfigOrderBy = {
- StartTime: 'start_time',
- ActivityScore: 'activity_score',
- RecordingDuration: 'recording_duration',
- Duration: 'duration',
- ClickCount: 'click_count',
- ConsoleErrorCount: 'console_error_count',
- } as const;
-
- /**
- * Sort direction for orderBy.
- */
- export type SessionReplayListWidgetConfigOrderDirection = typeof SessionReplayListWidgetConfigOrderDirection[keyof typeof SessionReplayListWidgetConfigOrderDirection];
-
-
- export const SessionReplayListWidgetConfigOrderDirection = {
- Asc: 'ASC',
- Desc: 'DESC',
- } as const;
-
- export type SessionReplayListWidgetConfigWidgetFilters = {[key: string]: WidgetFilterEntry} | null;
-
- export interface SessionReplayListWidgetConfig {
- dateRange?: WidgetDateRange | null;
- filterTestAccounts?: boolean | null;
- widgetFilters?: SessionReplayListWidgetConfigWidgetFilters;
- /**
- * Maximum number of recordings to return.
- * @minimum 1
- * @maximum 25
- */
- limit?: number;
- /** Recording ranking column. */
- orderBy?: SessionReplayListWidgetConfigOrderBy;
- /** Sort direction for orderBy. */
- orderDirection?: SessionReplayListWidgetConfigOrderDirection;
- /** short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection. */
- savedFilterId?: string | null;
- /** short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply. */
- collectionId?: string | null;
+ export interface _TileLayoutBoxOpenApi {
+ /** Column position in the dashboard grid (0-indexed). */
+ x?: number;
+ /** Row position in the dashboard grid (0-indexed). */
+ y?: number;
+ /** Width in grid columns. The desktop grid is 12 columns wide. */
+ w?: number;
+ /** Height in grid rows. */
+ h?: number;
}
- export interface SessionReplayListWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: SessionReplayListWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the recent recordings widget. */
- config: SessionReplayListWidgetConfig;
+ export interface _TileLayoutsOpenApi {
+ /** Layout for the standard (desktop) breakpoint. The grid is 12 columns wide. */
+ sm?: _TileLayoutBoxOpenApi;
+ /** Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders. */
+ xs?: _TileLayoutBoxOpenApi;
}
- export type ExperimentsListWidgetAddRequestOpenApiWidgetType = typeof ExperimentsListWidgetAddRequestOpenApiWidgetType[keyof typeof ExperimentsListWidgetAddRequestOpenApiWidgetType];
-
-
- export const ExperimentsListWidgetAddRequestOpenApiWidgetType = {
- ExperimentsList: 'experiments_list',
- } as const;
-
/**
- * Experiment list sort column.
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results
*/
- export type ExperimentsListWidgetConfigOrderBy = typeof ExperimentsListWidgetConfigOrderBy[keyof typeof ExperimentsListWidgetConfigOrderBy];
+ export type DashboardWidgetTypeEnum = typeof DashboardWidgetTypeEnum[keyof typeof DashboardWidgetTypeEnum];
- export const ExperimentsListWidgetConfigOrderBy = {
- CreatedAt: 'created_at',
- Name: 'name',
- StartDate: 'start_date',
- } as const;
-
- /**
- * Sort direction for orderBy.
- */
- export type ExperimentsListWidgetConfigOrderDirection = typeof ExperimentsListWidgetConfigOrderDirection[keyof typeof ExperimentsListWidgetConfigOrderDirection];
-
-
- export const ExperimentsListWidgetConfigOrderDirection = {
- Asc: 'ASC',
- Desc: 'DESC',
- } as const;
-
- /**
- * Experiment status filter.
- */
- export type ExperimentsListWidgetConfigStatus = typeof ExperimentsListWidgetConfigStatus[keyof typeof ExperimentsListWidgetConfigStatus];
-
-
- export const ExperimentsListWidgetConfigStatus = {
- Draft: 'draft',
- Running: 'running',
- Paused: 'paused',
- ExposureFrozen: 'exposure_frozen',
- Stopped: 'stopped',
- All: 'all',
- } as const;
-
- export interface ExperimentsListWidgetConfig {
- /**
- * Maximum number of experiments to return.
- * @minimum 1
- * @maximum 25
- */
- limit?: number;
- /** Experiment list sort column. */
- orderBy?: ExperimentsListWidgetConfigOrderBy;
- /** Sort direction for orderBy. */
- orderDirection?: ExperimentsListWidgetConfigOrderDirection;
- /** Experiment status filter. */
- status?: ExperimentsListWidgetConfigStatus;
- /** Filter by creator (user id). Omit for any creator. */
- createdBy?: number | null;
- }
-
- export interface ExperimentsListWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: ExperimentsListWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the experiments list widget. */
- config: ExperimentsListWidgetConfig;
- }
-
- export type ExperimentResultsWidgetAddRequestOpenApiWidgetType = typeof ExperimentResultsWidgetAddRequestOpenApiWidgetType[keyof typeof ExperimentResultsWidgetAddRequestOpenApiWidgetType];
-
-
- export const ExperimentResultsWidgetAddRequestOpenApiWidgetType = {
+ export const DashboardWidgetTypeEnum = {
+ ActivityEventsList: 'activity_events_list',
+ CanvasApp: 'canvas_app',
+ ConversationsRecentTickets: 'conversations_recent_tickets',
+ ErrorTrackingList: 'error_tracking_list',
ExperimentResults: 'experiment_results',
- } as const;
-
- export interface ExperimentResultsWidgetConfig {
- /** Experiment to show results for. Null until the user picks one in the widget settings. */
- experimentId?: number | null;
- }
-
- export interface ExperimentResultsWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: ExperimentResultsWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the experiment results widget. */
- config: ExperimentResultsWidgetConfig;
- }
-
- export type SurveyResultsWidgetAddRequestOpenApiWidgetType = typeof SurveyResultsWidgetAddRequestOpenApiWidgetType[keyof typeof SurveyResultsWidgetAddRequestOpenApiWidgetType];
-
-
- export const SurveyResultsWidgetAddRequestOpenApiWidgetType = {
- SurveyResults: 'survey_results',
- } as const;
-
- export interface SurveyResultsWidgetConfig {
- /** Null or omitted means all time (the survey's full lifetime). */
- dateRange?: WidgetDateRange | null;
- /** Survey to show performance stats and recent responses for. Null until the user picks one. */
- surveyId?: string | null;
- /**
- * Maximum number of recent responses to return.
- * @minimum 1
- * @maximum 25
- */
- limit?: number;
- }
-
- export interface SurveyResultsWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: SurveyResultsWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the survey results widget. */
- config: SurveyResultsWidgetConfig;
- }
-
- export type LogsListWidgetAddRequestOpenApiWidgetType = typeof LogsListWidgetAddRequestOpenApiWidgetType[keyof typeof LogsListWidgetAddRequestOpenApiWidgetType];
-
-
- export const LogsListWidgetAddRequestOpenApiWidgetType = {
+ ExperimentsList: 'experiments_list',
LogsList: 'logs_list',
+ NotebookWidget: 'notebook_widget',
+ SessionReplayList: 'session_replay_list',
+ SurveyResults: 'survey_results',
} as const;
- /**
- * Sort by newest (latest) or oldest (earliest) first.
- */
- export type LogsListWidgetConfigOrderBy = typeof LogsListWidgetConfigOrderBy[keyof typeof LogsListWidgetConfigOrderBy];
-
-
- export const LogsListWidgetConfigOrderBy = {
- Latest: 'latest',
- Earliest: 'earliest',
- } as const;
-
- export type LogsListWidgetConfigSeverityLevelsItem = typeof LogsListWidgetConfigSeverityLevelsItem[keyof typeof LogsListWidgetConfigSeverityLevelsItem];
-
-
- export const LogsListWidgetConfigSeverityLevelsItem = {
- Trace: 'trace',
- Debug: 'debug',
- Info: 'info',
- Warn: 'warn',
- Error: 'error',
- Fatal: 'fatal',
- } as const;
-
- /**
- * Render log timestamps in UTC or in each viewer's local timezone.
- */
- export type LogsListWidgetConfigTimezone = typeof LogsListWidgetConfigTimezone[keyof typeof LogsListWidgetConfigTimezone];
-
-
- export const LogsListWidgetConfigTimezone = {
- Utc: 'UTC',
- Local: 'local',
- } as const;
-
- export interface LogsListWidgetConfig {
- dateRange?: WidgetDateRange | null;
- /**
- * Maximum number of log lines to return.
- * @minimum 1
- * @maximum 100
- */
- limit?: number;
- /** Sort by newest (latest) or oldest (earliest) first. */
- orderBy?: LogsListWidgetConfigOrderBy;
- /** Only show logs at these severity levels. Empty shows all levels. */
- severityLevels?: LogsListWidgetConfigSeverityLevelsItem[];
- /** Only show logs from these services. Empty shows all services. */
- serviceNames?: string[];
- /** Wrap long log lines instead of truncating them to a single row. */
- wrapLines?: boolean;
- /** Render log timestamps in UTC or in each viewer's local timezone. */
- timezone?: LogsListWidgetConfigTimezone;
- /** short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply. */
- savedViewId?: string | null;
- }
-
- export interface LogsListWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: LogsListWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the recent logs widget. */
- config: LogsListWidgetConfig;
- }
-
- export type ConversationsRecentTicketsWidgetAddRequestOpenApiWidgetType = typeof ConversationsRecentTicketsWidgetAddRequestOpenApiWidgetType[keyof typeof ConversationsRecentTicketsWidgetAddRequestOpenApiWidgetType];
-
-
- export const ConversationsRecentTicketsWidgetAddRequestOpenApiWidgetType = {
- ConversationsRecentTickets: 'conversations_recent_tickets',
- } as const;
-
- /**
- * Ticket status filter.
- */
- export type ConversationsRecentTicketsWidgetConfigStatus = typeof ConversationsRecentTicketsWidgetConfigStatus[keyof typeof ConversationsRecentTicketsWidgetConfigStatus];
-
-
- export const ConversationsRecentTicketsWidgetConfigStatus = {
- New: 'new',
- Open: 'open',
- Pending: 'pending',
- OnHold: 'on_hold',
- Resolved: 'resolved',
- All: 'all',
- } as const;
-
- export type ConversationsRecentTicketsWidgetConfigPrioritiesItem = typeof ConversationsRecentTicketsWidgetConfigPrioritiesItem[keyof typeof ConversationsRecentTicketsWidgetConfigPrioritiesItem];
-
-
- export const ConversationsRecentTicketsWidgetConfigPrioritiesItem = {
- Low: 'low',
- Medium: 'medium',
- High: 'high',
- Critical: 'critical',
- } as const;
-
- /**
- * Ticket channel filter.
- */
- export type ConversationsRecentTicketsWidgetConfigChannel = typeof ConversationsRecentTicketsWidgetConfigChannel[keyof typeof ConversationsRecentTicketsWidgetConfigChannel];
-
-
- export const ConversationsRecentTicketsWidgetConfigChannel = {
- Widget: 'widget',
- Email: 'email',
- Slack: 'slack',
- Teams: 'teams',
- Github: 'github',
- All: 'all',
- } as const;
-
- export interface ConversationsRecentTicketsWidgetConfig {
- /**
- * Maximum number of tickets to return.
- * @minimum 1
- * @maximum 25
- */
- limit?: number;
- /** Ticket status filter. */
- status?: ConversationsRecentTicketsWidgetConfigStatus;
- /** Only show tickets with these priorities. Empty shows all priorities. */
- priorities?: ConversationsRecentTicketsWidgetConfigPrioritiesItem[];
- /** Ticket channel filter. */
- channel?: ConversationsRecentTicketsWidgetConfigChannel;
- /**
- * Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees.
- * @maxItems 100
- */
- assignees?: ('me' | 'unassigned' | WidgetAssigneeFilter)[];
- /**
- * Search requester name or email, ticket subject, message text, or ticket number.
- * @maxLength 200
- */
- search?: string;
- /** short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit. */
- savedViewId?: string | null;
- }
-
- export interface ConversationsRecentTicketsWidgetAddRequestOpenApi {
- /**
- * Optional custom display name for the widget tile.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** Optional markdown description shown when show_description is enabled. */
- description?: string;
- /** Optional react-grid-layout positions keyed by breakpoint (sm, xs). */
- layouts?: _TileLayoutsOpenApi;
- /** Whether to show the description on the dashboard tile. */
- show_description?: boolean;
- widget_type: ConversationsRecentTicketsWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the recent tickets widget. */
- config: ConversationsRecentTicketsWidgetConfig;
- }
-
- export type CanvasAppWidgetAddRequestOpenApiWidgetType = typeof CanvasAppWidgetAddRequestOpenApiWidgetType[keyof typeof CanvasAppWidgetAddRequestOpenApiWidgetType];
-
-
- export const CanvasAppWidgetAddRequestOpenApiWidgetType = {
- CanvasApp: 'canvas_app',
- } as const;
-
- export interface CanvasAppWidgetConfig {
- /** Canvas to render in the tile. Null until the user picks one in the widget settings. */
- canvasId?: string | null;
- }
-
- export interface CanvasAppWidgetAddRequestOpenApi {
+ export interface AddDashboardWidgetRequest {
/**
* Optional custom display name for the widget tile.
* @maxLength 400
@@ -8200,13 +7649,23 @@ export namespace Schemas {
layouts?: _TileLayoutsOpenApi;
/** Whether to show the description on the dashboard tile. */
show_description?: boolean;
- widget_type: CanvasAppWidgetAddRequestOpenApiWidgetType;
- /** Configuration for the canvas app widget. */
- config: CanvasAppWidgetConfig;
+ /** Widget type to add. Use dashboard-widget-catalog-list to pick one.
+ *
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type: DashboardWidgetTypeEnum;
+ /** Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. */
+ config: AddDashboardWidgetRequestConfig;
}
- export type AddDashboardWidgetRequest = NotebookWidgetAddRequestOpenApi | ActivityEventsListWidgetAddRequestOpenApi | ErrorTrackingListWidgetAddRequestOpenApi | SessionReplayListWidgetAddRequestOpenApi | ExperimentsListWidgetAddRequestOpenApi | ExperimentResultsWidgetAddRequestOpenApi | SurveyResultsWidgetAddRequestOpenApi | LogsListWidgetAddRequestOpenApi | ConversationsRecentTicketsWidgetAddRequestOpenApi | CanvasAppWidgetAddRequestOpenApi;
-
/**
* OpenAPI-only batch-add schema with widget_type-discriminated config shapes for agents.
*/
@@ -10062,6 +9521,18 @@ export namespace Schemas {
version?: number | null;
}
+ export type ErrorTrackingOrderBy = typeof ErrorTrackingOrderBy[keyof typeof ErrorTrackingOrderBy];
+
+
+ export const ErrorTrackingOrderBy = {
+ LastSeen: 'last_seen',
+ FirstSeen: 'first_seen',
+ Occurrences: 'occurrences',
+ Users: 'users',
+ Sessions: 'sessions',
+ Severity: 'severity',
+ } as const;
+
export type OrderDirection2 = typeof OrderDirection2[keyof typeof OrderDirection2];
@@ -11390,6 +10861,323 @@ export namespace Schemas {
team: number;
}
+ export interface NotebookWidgetConfig {
+ /** Source notebook short ID. */
+ notebookShortId?: string | null;
+ /** Immutable notebook widget snapshot. Add one from a notebook widget's menu. */
+ snapshotId?: string | null;
+ }
+
+ /**
+ * Sort direction for orderBy.
+ */
+ export type ErrorTrackingListWidgetConfigOrderDirection = typeof ErrorTrackingListWidgetConfigOrderDirection[keyof typeof ErrorTrackingListWidgetConfigOrderDirection];
+
+
+ export const ErrorTrackingListWidgetConfigOrderDirection = {
+ Asc: 'ASC',
+ Desc: 'DESC',
+ } as const;
+
+ /**
+ * Issue status filter.
+ */
+ export type ErrorTrackingListWidgetConfigStatus = typeof ErrorTrackingListWidgetConfigStatus[keyof typeof ErrorTrackingListWidgetConfigStatus];
+
+
+ export const ErrorTrackingListWidgetConfigStatus = {
+ Archived: 'archived',
+ Active: 'active',
+ Resolved: 'resolved',
+ PendingRelease: 'pending_release',
+ Suppressed: 'suppressed',
+ All: 'all',
+ } as const;
+
+ export type WidgetAssigneeFilterType = typeof WidgetAssigneeFilterType[keyof typeof WidgetAssigneeFilterType];
+
+
+ export const WidgetAssigneeFilterType = {
+ User: 'user',
+ Role: 'role',
+ } as const;
+
+ export interface WidgetAssigneeFilter {
+ id: string | number;
+ type: WidgetAssigneeFilterType;
+ }
+
+ export type ErrorTrackingListWidgetConfigWidgetFilters = {[key: string]: WidgetFilterEntry} | null;
+
+ export interface ErrorTrackingListWidgetConfig {
+ dateRange?: WidgetDateRange | null;
+ filterTestAccounts?: boolean | null;
+ widgetFilters?: ErrorTrackingListWidgetConfigWidgetFilters;
+ /**
+ * Maximum number of issues to return.
+ * @minimum 1
+ * @maximum 25
+ */
+ limit?: number;
+ /** Issue ranking column. */
+ orderBy?: ErrorTrackingOrderBy;
+ /** Sort direction for orderBy. */
+ orderDirection?: ErrorTrackingListWidgetConfigOrderDirection;
+ /** Issue status filter. */
+ status?: ErrorTrackingListWidgetConfigStatus;
+ /** Filter by assignee ({type: user|role, id}). Omit for any assignee. */
+ assignee?: WidgetAssigneeFilter | null;
+ }
+
+ /**
+ * Recording ranking column.
+ */
+ export type SessionReplayListWidgetConfigOrderBy = typeof SessionReplayListWidgetConfigOrderBy[keyof typeof SessionReplayListWidgetConfigOrderBy];
+
+
+ export const SessionReplayListWidgetConfigOrderBy = {
+ StartTime: 'start_time',
+ ActivityScore: 'activity_score',
+ RecordingDuration: 'recording_duration',
+ Duration: 'duration',
+ ClickCount: 'click_count',
+ ConsoleErrorCount: 'console_error_count',
+ } as const;
+
+ /**
+ * Sort direction for orderBy.
+ */
+ export type SessionReplayListWidgetConfigOrderDirection = typeof SessionReplayListWidgetConfigOrderDirection[keyof typeof SessionReplayListWidgetConfigOrderDirection];
+
+
+ export const SessionReplayListWidgetConfigOrderDirection = {
+ Asc: 'ASC',
+ Desc: 'DESC',
+ } as const;
+
+ export type SessionReplayListWidgetConfigWidgetFilters = {[key: string]: WidgetFilterEntry} | null;
+
+ export interface SessionReplayListWidgetConfig {
+ dateRange?: WidgetDateRange | null;
+ filterTestAccounts?: boolean | null;
+ widgetFilters?: SessionReplayListWidgetConfigWidgetFilters;
+ /**
+ * Maximum number of recordings to return.
+ * @minimum 1
+ * @maximum 25
+ */
+ limit?: number;
+ /** Recording ranking column. */
+ orderBy?: SessionReplayListWidgetConfigOrderBy;
+ /** Sort direction for orderBy. */
+ orderDirection?: SessionReplayListWidgetConfigOrderDirection;
+ /** short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection. */
+ savedFilterId?: string | null;
+ /** short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply. */
+ collectionId?: string | null;
+ }
+
+ /**
+ * Experiment list sort column.
+ */
+ export type ExperimentsListWidgetConfigOrderBy = typeof ExperimentsListWidgetConfigOrderBy[keyof typeof ExperimentsListWidgetConfigOrderBy];
+
+
+ export const ExperimentsListWidgetConfigOrderBy = {
+ CreatedAt: 'created_at',
+ Name: 'name',
+ StartDate: 'start_date',
+ } as const;
+
+ /**
+ * Sort direction for orderBy.
+ */
+ export type ExperimentsListWidgetConfigOrderDirection = typeof ExperimentsListWidgetConfigOrderDirection[keyof typeof ExperimentsListWidgetConfigOrderDirection];
+
+
+ export const ExperimentsListWidgetConfigOrderDirection = {
+ Asc: 'ASC',
+ Desc: 'DESC',
+ } as const;
+
+ /**
+ * Experiment status filter.
+ */
+ export type ExperimentsListWidgetConfigStatus = typeof ExperimentsListWidgetConfigStatus[keyof typeof ExperimentsListWidgetConfigStatus];
+
+
+ export const ExperimentsListWidgetConfigStatus = {
+ Draft: 'draft',
+ Running: 'running',
+ Paused: 'paused',
+ ExposureFrozen: 'exposure_frozen',
+ Stopped: 'stopped',
+ All: 'all',
+ } as const;
+
+ export interface ExperimentsListWidgetConfig {
+ /**
+ * Maximum number of experiments to return.
+ * @minimum 1
+ * @maximum 25
+ */
+ limit?: number;
+ /** Experiment list sort column. */
+ orderBy?: ExperimentsListWidgetConfigOrderBy;
+ /** Sort direction for orderBy. */
+ orderDirection?: ExperimentsListWidgetConfigOrderDirection;
+ /** Experiment status filter. */
+ status?: ExperimentsListWidgetConfigStatus;
+ /** Filter by creator (user id). Omit for any creator. */
+ createdBy?: number | null;
+ }
+
+ export interface ExperimentResultsWidgetConfig {
+ /** Experiment to show results for. Null until the user picks one in the widget settings. */
+ experimentId?: number | null;
+ }
+
+ export interface SurveyResultsWidgetConfig {
+ /** Null or omitted means all time (the survey's full lifetime). */
+ dateRange?: WidgetDateRange | null;
+ /** Survey to show performance stats and recent responses for. Null until the user picks one. */
+ surveyId?: string | null;
+ /**
+ * Maximum number of recent responses to return.
+ * @minimum 1
+ * @maximum 25
+ */
+ limit?: number;
+ }
+
+ /**
+ * Sort by newest (latest) or oldest (earliest) first.
+ */
+ export type LogsListWidgetConfigOrderBy = typeof LogsListWidgetConfigOrderBy[keyof typeof LogsListWidgetConfigOrderBy];
+
+
+ export const LogsListWidgetConfigOrderBy = {
+ Latest: 'latest',
+ Earliest: 'earliest',
+ } as const;
+
+ export type LogsListWidgetConfigSeverityLevelsItem = typeof LogsListWidgetConfigSeverityLevelsItem[keyof typeof LogsListWidgetConfigSeverityLevelsItem];
+
+
+ export const LogsListWidgetConfigSeverityLevelsItem = {
+ Trace: 'trace',
+ Debug: 'debug',
+ Info: 'info',
+ Warn: 'warn',
+ Error: 'error',
+ Fatal: 'fatal',
+ } as const;
+
+ /**
+ * Render log timestamps in UTC or in each viewer's local timezone.
+ */
+ export type LogsListWidgetConfigTimezone = typeof LogsListWidgetConfigTimezone[keyof typeof LogsListWidgetConfigTimezone];
+
+
+ export const LogsListWidgetConfigTimezone = {
+ Utc: 'UTC',
+ Local: 'local',
+ } as const;
+
+ export interface LogsListWidgetConfig {
+ dateRange?: WidgetDateRange | null;
+ /**
+ * Maximum number of log lines to return.
+ * @minimum 1
+ * @maximum 100
+ */
+ limit?: number;
+ /** Sort by newest (latest) or oldest (earliest) first. */
+ orderBy?: LogsListWidgetConfigOrderBy;
+ /** Only show logs at these severity levels. Empty shows all levels. */
+ severityLevels?: LogsListWidgetConfigSeverityLevelsItem[];
+ /** Only show logs from these services. Empty shows all services. */
+ serviceNames?: string[];
+ /** Wrap long log lines instead of truncating them to a single row. */
+ wrapLines?: boolean;
+ /** Render log timestamps in UTC or in each viewer's local timezone. */
+ timezone?: LogsListWidgetConfigTimezone;
+ /** short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply. */
+ savedViewId?: string | null;
+ }
+
+ /**
+ * Ticket status filter.
+ */
+ export type ConversationsRecentTicketsWidgetConfigStatus = typeof ConversationsRecentTicketsWidgetConfigStatus[keyof typeof ConversationsRecentTicketsWidgetConfigStatus];
+
+
+ export const ConversationsRecentTicketsWidgetConfigStatus = {
+ New: 'new',
+ Open: 'open',
+ Pending: 'pending',
+ OnHold: 'on_hold',
+ Resolved: 'resolved',
+ All: 'all',
+ } as const;
+
+ export type ConversationsRecentTicketsWidgetConfigPrioritiesItem = typeof ConversationsRecentTicketsWidgetConfigPrioritiesItem[keyof typeof ConversationsRecentTicketsWidgetConfigPrioritiesItem];
+
+
+ export const ConversationsRecentTicketsWidgetConfigPrioritiesItem = {
+ Low: 'low',
+ Medium: 'medium',
+ High: 'high',
+ Critical: 'critical',
+ } as const;
+
+ /**
+ * Ticket channel filter.
+ */
+ export type ConversationsRecentTicketsWidgetConfigChannel = typeof ConversationsRecentTicketsWidgetConfigChannel[keyof typeof ConversationsRecentTicketsWidgetConfigChannel];
+
+
+ export const ConversationsRecentTicketsWidgetConfigChannel = {
+ Widget: 'widget',
+ Email: 'email',
+ Slack: 'slack',
+ Teams: 'teams',
+ Github: 'github',
+ All: 'all',
+ } as const;
+
+ export interface ConversationsRecentTicketsWidgetConfig {
+ /**
+ * Maximum number of tickets to return.
+ * @minimum 1
+ * @maximum 25
+ */
+ limit?: number;
+ /** Ticket status filter. */
+ status?: ConversationsRecentTicketsWidgetConfigStatus;
+ /** Only show tickets with these priorities. Empty shows all priorities. */
+ priorities?: ConversationsRecentTicketsWidgetConfigPrioritiesItem[];
+ /** Ticket channel filter. */
+ channel?: ConversationsRecentTicketsWidgetConfigChannel;
+ /**
+ * Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees.
+ * @maxItems 100
+ */
+ assignees?: ('me' | 'unassigned' | WidgetAssigneeFilter)[];
+ /**
+ * Search requester name or email, ticket subject, message text, or ticket number.
+ * @maxLength 200
+ */
+ search?: string;
+ /** short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit. */
+ savedViewId?: string | null;
+ }
+
+ export interface CanvasAppWidgetConfig {
+ /** Canvas to render in the tile. Null until the user picks one in the widget settings. */
+ canvasId?: string | null;
+ }
+
export type DashboardWidgetConfig = NotebookWidgetConfig | ActivityEventsListWidgetConfig | ErrorTrackingListWidgetConfig | SessionReplayListWidgetConfig | ExperimentsListWidgetConfig | ExperimentResultsWidgetConfig | SurveyResultsWidgetConfig | LogsListWidgetConfig | ConversationsRecentTicketsWidgetConfig | CanvasAppWidgetConfig;
export interface DashboardWidget {
@@ -20658,7 +20446,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: CanvasAppWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -20676,29 +20464,6 @@ export namespace Schemas {
CanvasApp: 'canvas_app',
} as const;
- export type CanvasAppWidgetUpdateRequestOpenApiWidgetType = typeof CanvasAppWidgetUpdateRequestOpenApiWidgetType[keyof typeof CanvasAppWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const CanvasAppWidgetUpdateRequestOpenApiWidgetType = {
- CanvasApp: 'canvas_app',
- } as const;
-
- export interface CanvasAppWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: CanvasAppWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the canvas app widget. Omit to leave unchanged. */
- config?: CanvasAppWidgetConfig;
- }
-
/**
* One emitted file of a built canvas artifact.
*/
@@ -25802,7 +25567,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ConversationsRecentTicketsWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -25820,29 +25585,6 @@ export namespace Schemas {
ConversationsRecentTickets: 'conversations_recent_tickets',
} as const;
- export type ConversationsRecentTicketsWidgetUpdateRequestOpenApiWidgetType = typeof ConversationsRecentTicketsWidgetUpdateRequestOpenApiWidgetType[keyof typeof ConversationsRecentTicketsWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const ConversationsRecentTicketsWidgetUpdateRequestOpenApiWidgetType = {
- ConversationsRecentTickets: 'conversations_recent_tickets',
- } as const;
-
- export interface ConversationsRecentTicketsWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: ConversationsRecentTicketsWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the recent tickets widget. Omit to leave unchanged. */
- config?: ConversationsRecentTicketsWidgetConfig;
- }
-
export interface ConversationsTicketImage {
url: string;
author: string;
@@ -28506,50 +28248,22 @@ export namespace Schemas {
xs?: _DashboardPatchTileLayoutBoxOpenApi;
}
- /**
- * * `activity_events_list` - activity_events_list
- * * `canvas_app` - canvas_app
- * * `conversations_recent_tickets` - conversations_recent_tickets
- * * `error_tracking_list` - error_tracking_list
- * * `experiment_results` - experiment_results
- * * `experiments_list` - experiments_list
- * * `logs_list` - logs_list
- * * `notebook_widget` - notebook_widget
- * * `session_replay_list` - session_replay_list
- * * `survey_results` - survey_results
- */
- export type DashboardPatchWidgetOpenApiWidgetTypeEnum = typeof DashboardPatchWidgetOpenApiWidgetTypeEnum[keyof typeof DashboardPatchWidgetOpenApiWidgetTypeEnum];
-
-
- export const DashboardPatchWidgetOpenApiWidgetTypeEnum = {
- ActivityEventsList: 'activity_events_list',
- CanvasApp: 'canvas_app',
- ConversationsRecentTickets: 'conversations_recent_tickets',
- ErrorTrackingList: 'error_tracking_list',
- ExperimentResults: 'experiment_results',
- ExperimentsList: 'experiments_list',
- LogsList: 'logs_list',
- NotebookWidget: 'notebook_widget',
- SessionReplayList: 'session_replay_list',
- SurveyResults: 'survey_results',
- } as const;
-
export interface DashboardPatchWidgetOpenApi {
/** Existing widget row ID when updating a widget tile via dashboard PATCH. */
id?: string;
/** Widget type identifier (cannot be changed on update).
*
- * * `activity_events_list` - activity_events_list
- * * `canvas_app` - canvas_app
- * * `conversations_recent_tickets` - conversations_recent_tickets
- * * `error_tracking_list` - error_tracking_list
- * * `experiment_results` - experiment_results
- * * `experiments_list` - experiments_list
- * * `logs_list` - logs_list
- * * `notebook_widget` - notebook_widget
- * * `session_replay_list` - session_replay_list
- * * `survey_results` - survey_results */
- widget_type?: DashboardPatchWidgetOpenApiWidgetTypeEnum;
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type?: DashboardWidgetTypeEnum;
/** Widget-specific configuration. Shape depends on the tile's widget_type. */
config?: DashboardWidgetConfig;
/**
@@ -41975,7 +41689,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ErrorTrackingListWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -41993,29 +41707,6 @@ export namespace Schemas {
ErrorTrackingList: 'error_tracking_list',
} as const;
- export type ErrorTrackingListWidgetUpdateRequestOpenApiWidgetType = typeof ErrorTrackingListWidgetUpdateRequestOpenApiWidgetType[keyof typeof ErrorTrackingListWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const ErrorTrackingListWidgetUpdateRequestOpenApiWidgetType = {
- ErrorTrackingList: 'error_tracking_list',
- } as const;
-
- export interface ErrorTrackingListWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: ErrorTrackingListWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the top issues widget. Omit to leave unchanged. */
- config?: ErrorTrackingListWidgetConfig;
- }
-
export interface ErrorTrackingRecommendation {
/** Recommendation UUID. */
id: string;
@@ -46486,7 +46177,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ExperimentResultsWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -46504,29 +46195,6 @@ export namespace Schemas {
ExperimentResults: 'experiment_results',
} as const;
- export type ExperimentResultsWidgetUpdateRequestOpenApiWidgetType = typeof ExperimentResultsWidgetUpdateRequestOpenApiWidgetType[keyof typeof ExperimentResultsWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const ExperimentResultsWidgetUpdateRequestOpenApiWidgetType = {
- ExperimentResults: 'experiment_results',
- } as const;
-
- export interface ExperimentResultsWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: ExperimentResultsWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the experiment results widget. Omit to leave unchanged. */
- config?: ExperimentResultsWidgetConfig;
- }
-
export interface ExperimentSavedMetricLinkedExperiment {
/** Experiment ID. */
id: number;
@@ -48093,7 +47761,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: ExperimentsListWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -48111,29 +47779,6 @@ export namespace Schemas {
ExperimentsList: 'experiments_list',
} as const;
- export type ExperimentsListWidgetUpdateRequestOpenApiWidgetType = typeof ExperimentsListWidgetUpdateRequestOpenApiWidgetType[keyof typeof ExperimentsListWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const ExperimentsListWidgetUpdateRequestOpenApiWidgetType = {
- ExperimentsList: 'experiments_list',
- } as const;
-
- export interface ExperimentsListWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: ExperimentsListWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the experiments list widget. Omit to leave unchanged. */
- config?: ExperimentsListWidgetConfig;
- }
-
export interface ExplainRequest {
/** UUID of the log entry to explain */
uuid: string;
@@ -65736,7 +65381,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: LogsListWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -65754,29 +65399,6 @@ export namespace Schemas {
LogsList: 'logs_list',
} as const;
- export type LogsListWidgetUpdateRequestOpenApiWidgetType = typeof LogsListWidgetUpdateRequestOpenApiWidgetType[keyof typeof LogsListWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const LogsListWidgetUpdateRequestOpenApiWidgetType = {
- LogsList: 'logs_list',
- } as const;
-
- export interface LogsListWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: LogsListWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the recent logs widget. Omit to leave unchanged. */
- config?: LogsListWidgetConfig;
- }
-
/**
* * `logs` - Logs
* * `spans` - Spans
@@ -70233,7 +69855,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: NotebookWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -70251,29 +69873,6 @@ export namespace Schemas {
NotebookWidget: 'notebook_widget',
} as const;
- export type NotebookWidgetUpdateRequestOpenApiWidgetType = typeof NotebookWidgetUpdateRequestOpenApiWidgetType[keyof typeof NotebookWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const NotebookWidgetUpdateRequestOpenApiWidgetType = {
- NotebookWidget: 'notebook_widget',
- } as const;
-
- export interface NotebookWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: NotebookWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the notebook widget widget. Omit to leave unchanged. */
- config?: NotebookWidgetConfig;
- }
-
/**
* Optional structured payload for rich client-side rendering, specific to the notification type. For `web_analytics_digest`, holds the weekly metrics (visitors, pageviews, sessions, bounce rate, session duration with week-over-week change), top pages, and top sources used to render the digest card.
* @nullable
@@ -89491,37 +89090,12 @@ export namespace Schemas {
memory_gb?: number;
}
- export type SessionReplayListWidgetUpdateRequestOpenApiWidgetType = typeof SessionReplayListWidgetUpdateRequestOpenApiWidgetType[keyof typeof SessionReplayListWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const SessionReplayListWidgetUpdateRequestOpenApiWidgetType = {
- SessionReplayList: 'session_replay_list',
- } as const;
-
- export interface SessionReplayListWidgetUpdateRequestOpenApi {
- /** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
- tile_id: number;
- /**
- * New display name for the widget. Empty string or null clears it; omit to leave unchanged.
- * @maxLength 400
- * @nullable
- */
- name?: string | null;
- /** New markdown description for the widget. Omit to leave unchanged. */
- description?: string;
- widget_type: SessionReplayListWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the recent recordings widget. Omit to leave unchanged. */
- config?: SessionReplayListWidgetConfig;
- }
-
- export type SurveyResultsWidgetUpdateRequestOpenApiWidgetType = typeof SurveyResultsWidgetUpdateRequestOpenApiWidgetType[keyof typeof SurveyResultsWidgetUpdateRequestOpenApiWidgetType];
-
-
- export const SurveyResultsWidgetUpdateRequestOpenApiWidgetType = {
- SurveyResults: 'survey_results',
- } as const;
+ /**
+ * Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged.
+ */
+ export type UpdateDashboardWidgetRequestConfig = { [key: string]: unknown };
- export interface SurveyResultsWidgetUpdateRequestOpenApi {
+ export interface UpdateDashboardWidgetRequest {
/** ID of the widget tile to update. Use dashboard-get to look up widget tile IDs. */
tile_id: number;
/**
@@ -89532,13 +89106,23 @@ export namespace Schemas {
name?: string | null;
/** New markdown description for the widget. Omit to leave unchanged. */
description?: string;
- widget_type: SurveyResultsWidgetUpdateRequestOpenApiWidgetType;
- /** New configuration for the survey results widget. Omit to leave unchanged. */
- config?: SurveyResultsWidgetConfig;
+ /** The tile's widget type. It cannot be changed, so omit it or pass the current type.
+ *
+ * * `activity_events_list` - Activity Events List
+ * * `canvas_app` - Canvas App
+ * * `conversations_recent_tickets` - Conversations Recent Tickets
+ * * `error_tracking_list` - Error Tracking List
+ * * `experiment_results` - Experiment Results
+ * * `experiments_list` - Experiments List
+ * * `logs_list` - Logs List
+ * * `notebook_widget` - Notebook Widget
+ * * `session_replay_list` - Session Replay List
+ * * `survey_results` - Survey Results */
+ widget_type?: DashboardWidgetTypeEnum;
+ /** Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged. */
+ config?: UpdateDashboardWidgetRequestConfig;
}
- export type UpdateDashboardWidgetRequest = NotebookWidgetUpdateRequestOpenApi | ActivityEventsListWidgetUpdateRequestOpenApi | ErrorTrackingListWidgetUpdateRequestOpenApi | SessionReplayListWidgetUpdateRequestOpenApi | ExperimentsListWidgetUpdateRequestOpenApi | ExperimentResultsWidgetUpdateRequestOpenApi | SurveyResultsWidgetUpdateRequestOpenApi | LogsListWidgetUpdateRequestOpenApi | ConversationsRecentTicketsWidgetUpdateRequestOpenApi | CanvasAppWidgetUpdateRequestOpenApi;
-
/**
* OpenAPI-only batch-update schema with widget_type-discriminated config shapes for agents.
*/
@@ -104547,7 +104131,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: SessionReplayListWidgetConfig;
/** @nullable */
required_product_access?: string | null;
@@ -111913,7 +111497,7 @@ export namespace Schemas {
group_label: string;
label: string;
description: string;
- /** OpenAPI config shape for this widget type (documentation; matches batch-add/PATCH schemas). */
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
readonly config_schema: SurveyResultsWidgetConfig;
/** @nullable */
required_product_access?: string | null;
diff --git a/services/mcp/src/generated/dashboards/api.ts b/services/mcp/src/generated/dashboards/api.ts
index b934b8a28e68..f7c2e4f1ec7b 100644
--- a/services/mcp/src/generated/dashboards/api.ts
+++ b/services/mcp/src/generated/dashboards/api.ts
@@ -816,80 +816,7 @@ export const DashboardsWidgetsBatchCreateQueryParams = () => zod.object({
format: zod.enum(['json', 'txt']).optional(),
})
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemOneNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemOneConfigOneNotebookShortIdOneMax = 128
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOneLimitDefault = 25
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOneLimitMax = 50
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax = 4000
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax = 100
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax = 4000
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneMax = 20
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneLimitDefault = 10
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneLimitMax = 25
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneOrderByDefault = `occurrences`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneStatusDefault = `active`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFourNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneLimitDefault = 10
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneLimitMax = 25
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneOrderByDefault = `start_time`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneLimitDefault = 10
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneLimitMax = 25
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneOrderByDefault = `created_at`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneStatusDefault = `all`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemSixNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemSevenNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemSevenConfigOneLimitDefault = 10
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemSevenConfigOneLimitMax = 25
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneLimitDefault = 50
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneLimitMax = 100
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneOrderByDefault = `latest`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneWrapLinesDefault = false
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneTimezoneDefault = `UTC`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineNameMax = 400
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneLimitDefault = 10
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneLimitMax = 25
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneStatusDefault = `all`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneChannelDefault = `all`
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneAssigneesMax = 100
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSearchDefault = ``
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSearchMax = 200
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSavedViewIdOneMax = 12
-
-export const dashboardsWidgetsBatchCreateBodyWidgetsItemOnezeroNameMax = 400
+export const dashboardsWidgetsBatchCreateBodyWidgetsItemNameMax = 400
export const dashboardsWidgetsBatchCreateBodyWidgetsMax = 10
@@ -897,1273 +824,88 @@ export const DashboardsWidgetsBatchCreateBody = () => zod
.object({
widgets: zod
.array(
- zod.union([
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemOneNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['notebook_widget']),
- config: zod
- .object({
- notebookShortId: zod
- .union([
- zod
- .string()
- .min(1)
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemOneConfigOneNotebookShortIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Source notebook short ID.'),
- snapshotId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- "Immutable notebook widget snapshot. Add one from a notebook widget's menu."
- ),
- })
- .describe('Configuration for the notebook widget widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemTwoNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['activity_events_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOneLimitDefault)
- .describe('Maximum number of events to return.'),
- eventName: zod
- .union([zod.string().min(1), zod.null()])
- .optional()
- .describe('Limit the feed to a single event name. Omit or null for all events.'),
- properties: zod
- .union([
- zod
- .array(
- zod.object({
- key: zod
- .string()
- .min(1)
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax
- ),
- label: zod
- .union([
- zod
- .string()
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax
- ),
- zod.null(),
- ])
- .optional(),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- type: zod.enum(['event', 'person']),
- value: zod
- .union([
- zod
- .array(
- zod.union([
- zod
- .string()
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax
- ),
- zod.number(),
- zod.boolean(),
- ])
- )
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax
- ),
- zod
- .string()
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax
- ),
- zod.number(),
- zod.boolean(),
- zod.null(),
- ])
- .optional(),
- })
- )
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemTwoConfigOnePropertiesOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Event and person property filters, matching Activity > Explore events.'),
- })
- .describe('Configuration for the recent events widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemThreeNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['error_tracking_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneLimitDefault)
- .describe('Maximum number of issues to return.'),
- orderBy: zod
- .enum(['last_seen', 'first_seen', 'occurrences', 'users', 'sessions', 'severity'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneOrderByDefault)
- .describe('Issue ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['archived', 'active', 'resolved', 'pending_release', 'suppressed', 'all'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemThreeConfigOneStatusDefault)
- .describe('Issue status filter.'),
- assignee: zod
- .union([
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- zod.null(),
- ])
- .optional()
- .describe('Filter by assignee ({type: user|role, id}). Omit for any assignee.'),
- })
- .describe('Configuration for the top issues widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemFourNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['session_replay_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneLimitDefault)
- .describe('Maximum number of recordings to return.'),
- orderBy: zod
- .enum([
- 'start_time',
- 'activity_score',
- 'recording_duration',
- 'duration',
- 'click_count',
- 'console_error_count',
- ])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneOrderByDefault)
- .describe('Recording ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsWidgetsBatchCreateBodyWidgetsItemFourConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- savedFilterId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection.'
- ),
- collectionId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply.'
- ),
- })
- .describe('Configuration for the recent recordings widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemFiveNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['experiments_list']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneLimitDefault)
- .describe('Maximum number of experiments to return.'),
- orderBy: zod
- .enum(['created_at', 'name', 'start_date'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneOrderByDefault)
- .describe('Experiment list sort column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['draft', 'running', 'paused', 'exposure_frozen', 'stopped', 'all'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemFiveConfigOneStatusDefault)
- .describe('Experiment status filter.'),
- createdBy: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe('Filter by creator (user id). Omit for any creator.'),
- })
- .describe('Configuration for the experiments list widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemSixNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['experiment_results']),
- config: zod
- .object({
- experimentId: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe(
- 'Experiment to show results for. Null until the user picks one in the widget settings.'
- ),
- })
- .describe('Configuration for the experiment results widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemSevenNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['survey_results']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional()
- .describe("Null or omitted means all time (the survey's full lifetime)."),
- surveyId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'Survey to show performance stats and recent responses for. Null until the user picks one.'
- ),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemSevenConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemSevenConfigOneLimitDefault)
- .describe('Maximum number of recent responses to return.'),
- })
- .describe('Configuration for the survey results widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemEightNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['logs_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneLimitDefault)
- .describe('Maximum number of log lines to return.'),
- orderBy: zod
- .enum(['latest', 'earliest'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneOrderByDefault)
- .describe('Sort by newest (latest) or oldest (earliest) first.'),
- severityLevels: zod
- .array(zod.enum(['trace', 'debug', 'info', 'warn', 'error', 'fatal']))
- .optional()
- .describe('Only show logs at these severity levels. Empty shows all levels.'),
- serviceNames: zod
- .array(zod.string())
- .optional()
- .describe('Only show logs from these services. Empty shows all services.'),
- wrapLines: zod
- .boolean()
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneWrapLinesDefault)
- .describe('Wrap long log lines instead of truncating them to a single row.'),
- timezone: zod
- .enum(['UTC', 'local'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemEightConfigOneTimezoneDefault)
- .describe("Render log timestamps in UTC or in each viewer's local timezone."),
- savedViewId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply.'
- ),
- })
- .describe('Configuration for the recent logs widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNineNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['conversations_recent_tickets']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneLimitMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneLimitDefault)
- .describe('Maximum number of tickets to return.'),
- status: zod
- .enum(['new', 'open', 'pending', 'on_hold', 'resolved', 'all'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneStatusDefault)
- .describe('Ticket status filter.'),
- priorities: zod
- .array(zod.enum(['low', 'medium', 'high', 'critical']))
- .optional()
- .describe('Only show tickets with these priorities. Empty shows all priorities.'),
- channel: zod
- .enum(['widget', 'email', 'slack', 'teams', 'github', 'all'])
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneChannelDefault)
- .describe('Ticket channel filter.'),
- assignees: zod
- .array(
- zod.union([
- zod.enum(['me', 'unassigned']),
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- ])
- )
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneAssigneesMax)
- .optional()
- .describe(
- "Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees."
- ),
- search: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSearchMax)
- .default(dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSearchDefault)
- .describe(
- 'Search requester name or email, ticket subject, message text, or ticket number.'
- ),
- savedViewId: zod
- .union([
- zod
- .string()
- .max(
- dashboardsWidgetsBatchCreateBodyWidgetsItemNineConfigOneSavedViewIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe(
- 'short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit.'
- ),
- })
- .describe('Configuration for the recent tickets widget.'),
- }),
- zod.object({
- name: zod
- .string()
- .max(dashboardsWidgetsBatchCreateBodyWidgetsItemOnezeroNameMax)
- .nullish()
- .describe('Optional custom display name for the widget tile.'),
- description: zod
- .string()
- .optional()
- .describe('Optional markdown description shown when show_description is enabled.'),
- layouts: zod
- .object({
- sm: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
- ),
- xs: zod
- .object({
- x: zod
- .number()
- .optional()
- .describe('Column position in the dashboard grid (0-indexed).'),
- y: zod
- .number()
- .optional()
- .describe('Row position in the dashboard grid (0-indexed).'),
- w: zod
- .number()
- .optional()
- .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
- h: zod.number().optional().describe('Height in grid rows.'),
- })
- .optional()
- .describe(
- 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
- ),
- })
- .optional()
- .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
- show_description: zod
- .boolean()
- .optional()
- .describe('Whether to show the description on the dashboard tile.'),
- widget_type: zod.enum(['canvas_app']),
- config: zod
- .object({
- canvasId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'Canvas to render in the tile. Null until the user picks one in the widget settings.'
- ),
- })
- .describe('Configuration for the canvas app widget.'),
- }),
- ])
+ zod.object({
+ name: zod
+ .string()
+ .max(dashboardsWidgetsBatchCreateBodyWidgetsItemNameMax)
+ .nullish()
+ .describe('Optional custom display name for the widget tile.'),
+ description: zod
+ .string()
+ .optional()
+ .describe('Optional markdown description shown when show_description is enabled.'),
+ layouts: zod
+ .object({
+ sm: zod
+ .object({
+ x: zod
+ .number()
+ .optional()
+ .describe('Column position in the dashboard grid (0-indexed).'),
+ y: zod
+ .number()
+ .optional()
+ .describe('Row position in the dashboard grid (0-indexed).'),
+ w: zod
+ .number()
+ .optional()
+ .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
+ h: zod.number().optional().describe('Height in grid rows.'),
+ })
+ .optional()
+ .describe('Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'),
+ xs: zod
+ .object({
+ x: zod
+ .number()
+ .optional()
+ .describe('Column position in the dashboard grid (0-indexed).'),
+ y: zod
+ .number()
+ .optional()
+ .describe('Row position in the dashboard grid (0-indexed).'),
+ w: zod
+ .number()
+ .optional()
+ .describe('Width in grid columns. The desktop grid is 12 columns wide.'),
+ h: zod.number().optional().describe('Height in grid rows.'),
+ })
+ .optional()
+ .describe(
+ 'Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.'
+ ),
+ })
+ .optional()
+ .describe('Optional react-grid-layout positions keyed by breakpoint (sm, xs).'),
+ show_description: zod
+ .boolean()
+ .optional()
+ .describe('Whether to show the description on the dashboard tile.'),
+ widget_type: zod
+ .enum([
+ 'activity_events_list',
+ 'canvas_app',
+ 'conversations_recent_tickets',
+ 'error_tracking_list',
+ 'experiment_results',
+ 'experiments_list',
+ 'logs_list',
+ 'notebook_widget',
+ 'session_replay_list',
+ 'survey_results',
+ ])
+ .describe(
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ )
+ .describe(
+ 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ ),
+ config: zod
+ .record(zod.string(), zod.unknown())
+ .describe(
+ "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field."
+ ),
+ })
)
.min(1)
.max(dashboardsWidgetsBatchCreateBodyWidgetsMax)
@@ -2195,80 +937,7 @@ export const DashboardsUpdateWidgetsBatchQueryParams = () => zod.object({
format: zod.enum(['json', 'txt']).optional(),
})
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOneNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOneConfigOneNotebookShortIdOneMax = 128
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitDefault = 25
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitMax = 50
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax = 4000
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax = 4000
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneMax = 20
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderByDefault = `occurrences`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneStatusDefault = `active`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderByDefault = `start_time`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderByDefault = `created_at`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderDirectionDefault = `DESC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneStatusDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSixNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitDefault = 50
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneOrderByDefault = `latest`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneWrapLinesDefault = false
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneTimezoneDefault = `UTC`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineNameMax = 400
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitDefault = 10
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitMax = 25
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneStatusDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneChannelDefault = `all`
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneAssigneesMax = 100
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchDefault = ``
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchMax = 200
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSavedViewIdOneMax = 12
-
-export const dashboardsUpdateWidgetsBatchBodyWidgetsItemOnezeroNameMax = 400
+export const dashboardsUpdateWidgetsBatchBodyWidgetsItemNameMax = 400
export const dashboardsUpdateWidgetsBatchBodyWidgetsMax = 10
@@ -2276,843 +945,48 @@ export const DashboardsUpdateWidgetsBatchBody = () => zod
.object({
widgets: zod
.array(
- zod.union([
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemOneNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['notebook_widget']),
- config: zod
- .object({
- notebookShortId: zod
- .union([
- zod
- .string()
- .min(1)
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemOneConfigOneNotebookShortIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Source notebook short ID.'),
- snapshotId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- "Immutable notebook widget snapshot. Add one from a notebook widget's menu."
- ),
- })
- .optional()
- .describe('New configuration for the notebook widget widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['activity_events_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOneLimitDefault)
- .describe('Maximum number of events to return.'),
- eventName: zod
- .union([zod.string().min(1), zod.null()])
- .optional()
- .describe('Limit the feed to a single event name. Omit or null for all events.'),
- properties: zod
- .union([
- zod
- .array(
- zod.object({
- key: zod
- .string()
- .min(1)
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemKeyMax
- ),
- label: zod
- .union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemLabelOneMax
- ),
- zod.null(),
- ])
- .optional(),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- type: zod.enum(['event', 'person']),
- value: zod
- .union([
- zod
- .array(
- zod.union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneItemOneMax
- ),
- zod.number(),
- zod.boolean(),
- ])
- )
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueOneMax
- ),
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneItemValueTwoMax
- ),
- zod.number(),
- zod.boolean(),
- zod.null(),
- ])
- .optional(),
- })
- )
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemTwoConfigOnePropertiesOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe('Event and person property filters, matching Activity > Explore events.'),
- })
- .optional()
- .describe('New configuration for the recent events widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['error_tracking_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneLimitDefault)
- .describe('Maximum number of issues to return.'),
- orderBy: zod
- .enum(['last_seen', 'first_seen', 'occurrences', 'users', 'sessions', 'severity'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderByDefault)
- .describe('Issue ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['archived', 'active', 'resolved', 'pending_release', 'suppressed', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemThreeConfigOneStatusDefault)
- .describe('Issue status filter.'),
- assignee: zod
- .union([
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- zod.null(),
- ])
- .optional()
- .describe('Filter by assignee ({type: user|role, id}). Omit for any assignee.'),
- })
- .optional()
- .describe('New configuration for the top issues widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['session_replay_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- filterTestAccounts: zod.union([zod.boolean(), zod.null()]).optional(),
- widgetFilters: zod
- .union([
- zod.record(
- zod.string(),
- zod.object({
- filterId: zod.string().min(1),
- propertyName: zod.string().min(1),
- optionId: zod.string().min(1),
- operator: zod.enum([
- 'exact',
- 'is_not',
- 'icontains',
- 'not_icontains',
- 'starts_with',
- 'not_starts_with',
- 'ends_with',
- 'not_ends_with',
- 'regex',
- 'not_regex',
- 'gt',
- 'gte',
- 'lt',
- 'lte',
- 'is_set',
- 'is_not_set',
- 'is_date_exact',
- 'is_date_before',
- 'is_date_after',
- 'between',
- 'not_between',
- 'min',
- 'max',
- 'in',
- 'not_in',
- 'is_cleaned_path_exact',
- 'is_cleaned_path_not_exact',
- 'flag_evaluates_to',
- 'semver_eq',
- 'semver_neq',
- 'semver_gt',
- 'semver_gte',
- 'semver_lt',
- 'semver_lte',
- 'semver_tilde',
- 'semver_caret',
- 'semver_wildcard',
- 'icontains_multi',
- 'not_icontains_multi',
- ]),
- value: zod
- .union([zod.string(), zod.array(zod.string()), zod.null()])
- .optional(),
- })
- ),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneLimitDefault)
- .describe('Maximum number of recordings to return.'),
- orderBy: zod
- .enum([
- 'start_time',
- 'activity_score',
- 'recording_duration',
- 'duration',
- 'click_count',
- 'console_error_count',
- ])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderByDefault)
- .describe('Recording ranking column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemFourConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- savedFilterId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection.'
- ),
- collectionId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply.'
- ),
- })
- .optional()
- .describe('New configuration for the recent recordings widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['experiments_list']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneLimitDefault)
- .describe('Maximum number of experiments to return.'),
- orderBy: zod
- .enum(['created_at', 'name', 'start_date'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderByDefault)
- .describe('Experiment list sort column.'),
- orderDirection: zod
- .enum(['ASC', 'DESC'])
- .default(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneOrderDirectionDefault
- )
- .describe('Sort direction for orderBy.'),
- status: zod
- .enum(['draft', 'running', 'paused', 'exposure_frozen', 'stopped', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemFiveConfigOneStatusDefault)
- .describe('Experiment status filter.'),
- createdBy: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe('Filter by creator (user id). Omit for any creator.'),
- })
- .optional()
- .describe('New configuration for the experiments list widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSixNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['experiment_results']),
- config: zod
- .object({
- experimentId: zod
- .union([zod.number(), zod.null()])
- .optional()
- .describe(
- 'Experiment to show results for. Null until the user picks one in the widget settings.'
- ),
- })
- .optional()
- .describe('New configuration for the experiment results widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['survey_results']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional()
- .describe("Null or omitted means all time (the survey's full lifetime)."),
- surveyId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'Survey to show performance stats and recent responses for. Null until the user picks one.'
- ),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemSevenConfigOneLimitDefault)
- .describe('Maximum number of recent responses to return.'),
- })
- .optional()
- .describe('New configuration for the survey results widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['logs_list']),
- config: zod
- .object({
- dateRange: zod
- .union([
- zod.object({
- date_from: zod
- .union([
- zod.enum([
- '-1M',
- '-30M',
- '-1h',
- '-3h',
- '-24h',
- '-7d',
- '-14d',
- '-30d',
- '-90d',
- ]),
- zod.null(),
- ])
- .optional(),
- }),
- zod.null(),
- ])
- .optional(),
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneLimitDefault)
- .describe('Maximum number of log lines to return.'),
- orderBy: zod
- .enum(['latest', 'earliest'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneOrderByDefault)
- .describe('Sort by newest (latest) or oldest (earliest) first.'),
- severityLevels: zod
- .array(zod.enum(['trace', 'debug', 'info', 'warn', 'error', 'fatal']))
- .optional()
- .describe('Only show logs at these severity levels. Empty shows all levels.'),
- serviceNames: zod
- .array(zod.string())
- .optional()
- .describe('Only show logs from these services. Empty shows all services.'),
- wrapLines: zod
- .boolean()
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneWrapLinesDefault)
- .describe('Wrap long log lines instead of truncating them to a single row.'),
- timezone: zod
- .enum(['UTC', 'local'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemEightConfigOneTimezoneDefault)
- .describe("Render log timestamps in UTC or in each viewer's local timezone."),
- savedViewId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply.'
- ),
- })
- .optional()
- .describe('New configuration for the recent logs widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['conversations_recent_tickets']),
- config: zod
- .object({
- limit: zod
- .number()
- .min(1)
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneLimitDefault)
- .describe('Maximum number of tickets to return.'),
- status: zod
- .enum(['new', 'open', 'pending', 'on_hold', 'resolved', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneStatusDefault)
- .describe('Ticket status filter.'),
- priorities: zod
- .array(zod.enum(['low', 'medium', 'high', 'critical']))
- .optional()
- .describe('Only show tickets with these priorities. Empty shows all priorities.'),
- channel: zod
- .enum(['widget', 'email', 'slack', 'teams', 'github', 'all'])
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneChannelDefault)
- .describe('Ticket channel filter.'),
- assignees: zod
- .array(
- zod.union([
- zod.enum(['me', 'unassigned']),
- zod.object({
- id: zod.union([zod.string(), zod.number()]),
- type: zod.enum(['user', 'role']),
- }),
- ])
- )
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneAssigneesMax)
- .optional()
- .describe(
- "Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees."
- ),
- search: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchMax)
- .default(dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSearchDefault)
- .describe(
- 'Search requester name or email, ticket subject, message text, or ticket number.'
- ),
- savedViewId: zod
- .union([
- zod
- .string()
- .max(
- dashboardsUpdateWidgetsBatchBodyWidgetsItemNineConfigOneSavedViewIdOneMax
- ),
- zod.null(),
- ])
- .optional()
- .describe(
- 'short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit.'
- ),
- })
- .optional()
- .describe('New configuration for the recent tickets widget. Omit to leave unchanged.'),
- }),
- zod.object({
- tile_id: zod
- .number()
- .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
- name: zod
- .string()
- .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemOnezeroNameMax)
- .nullish()
- .describe(
- 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
- ),
- description: zod
- .string()
- .optional()
- .describe('New markdown description for the widget. Omit to leave unchanged.'),
- widget_type: zod.enum(['canvas_app']),
- config: zod
- .object({
- canvasId: zod
- .union([zod.string(), zod.null()])
- .optional()
- .describe(
- 'Canvas to render in the tile. Null until the user picks one in the widget settings.'
- ),
- })
- .optional()
- .describe('New configuration for the canvas app widget. Omit to leave unchanged.'),
- }),
- ])
+ zod.object({
+ tile_id: zod
+ .number()
+ .describe('ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.'),
+ name: zod
+ .string()
+ .max(dashboardsUpdateWidgetsBatchBodyWidgetsItemNameMax)
+ .nullish()
+ .describe(
+ 'New display name for the widget. Empty string or null clears it; omit to leave unchanged.'
+ ),
+ description: zod
+ .string()
+ .optional()
+ .describe('New markdown description for the widget. Omit to leave unchanged.'),
+ widget_type: zod
+ .enum([
+ 'activity_events_list',
+ 'canvas_app',
+ 'conversations_recent_tickets',
+ 'error_tracking_list',
+ 'experiment_results',
+ 'experiments_list',
+ 'logs_list',
+ 'notebook_widget',
+ 'session_replay_list',
+ 'survey_results',
+ ])
+ .describe(
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ )
+ .optional()
+ .describe(
+ "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
+ ),
+ config: zod
+ .record(zod.string(), zod.unknown())
+ .optional()
+ .describe(
+ "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged."
+ ),
+ })
)
.min(1)
.max(dashboardsUpdateWidgetsBatchBodyWidgetsMax)
diff --git a/services/mcp/src/schema/tool-inputs.ts b/services/mcp/src/schema/tool-inputs.ts
index 86e84fdee296..0ee0b318f93d 100644
--- a/services/mcp/src/schema/tool-inputs.ts
+++ b/services/mcp/src/schema/tool-inputs.ts
@@ -46,10 +46,10 @@ export const ChannelInstructionsBaseVersionSchema = z
.describe('Version returned by channel-instructions-retrieve. Use 0 when the channel has no instructions.')
const DashboardTileLayoutSchema = z.object({
- x: z.number().int().min(0).optional(),
- y: z.number().int().min(0).optional(),
- w: z.number().int().min(1).optional(),
- h: z.number().int().min(1).optional(),
+ x: z.number().int().min(0).optional().describe('Column position in the dashboard grid (0-indexed).'),
+ y: z.number().int().min(0).optional().describe('Row position in the dashboard grid (0-indexed).'),
+ w: z.number().int().min(1).optional().describe('Width in grid columns. The desktop grid is 12 columns wide.'),
+ h: z.number().int().min(1).optional().describe('Height in grid rows.'),
})
export const DashboardTileCreateSchema = z.object({
@@ -74,8 +74,12 @@ export const DashboardTileCreateSchema = z.object({
),
layouts: z
.object({
- sm: DashboardTileLayoutSchema.optional(),
- xs: DashboardTileLayoutSchema.optional(),
+ sm: DashboardTileLayoutSchema.optional().describe(
+ 'Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.'
+ ),
+ xs: DashboardTileLayoutSchema.optional().describe(
+ 'Layout for the small (mobile) breakpoint. The grid is 1 column wide.'
+ ),
})
.optional()
.describe('Optional dashboard-grid layout for desktop (sm) and mobile (xs).'),
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-create-tile.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-create-tile.json
index 2bb223510197..5f69f10a7c2a 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-create-tile.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-create-tile.json
@@ -41,23 +41,28 @@
"description": "Optional dashboard-grid layout for desktop (sm) and mobile (xs).",
"properties": {
"sm": {
+ "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
"properties": {
"h": {
+ "description": "Height in grid rows.",
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
@@ -66,23 +71,28 @@
"type": "object"
},
"xs": {
+ "description": "Layout for the small (mobile) breakpoint. The grid is 1 column wide.",
"properties": {
"h": {
+ "description": "Height in grid rows.",
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
index 4750bfad6a3a..8ac18831274b 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
@@ -8,1816 +8,104 @@
"widgets": {
"description": "Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).",
"items": {
- "anyOf": [
- {
- "properties": {
- "config": {
- "description": "Configuration for the notebook widget widget.",
- "properties": {
- "notebookShortId": {
- "anyOf": [
- {
- "maxLength": 128,
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Source notebook short ID."
- },
- "snapshotId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Immutable notebook widget snapshot. Add one from a notebook widget's menu."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["notebook_widget"],
- "type": "string"
- }
+ "properties": {
+ "config": {
+ "additionalProperties": {},
+ "description": "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field.",
+ "propertyNames": {
+ "type": "string"
},
- "required": ["widget_type", "config"],
"type": "object"
},
- {
- "properties": {
- "config": {
- "description": "Configuration for the recent events widget.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "eventName": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Limit the feed to a single event name. Omit or null for all events."
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 25,
- "description": "Maximum number of events to return.",
- "maximum": 50,
- "minimum": 1,
- "type": "number"
- },
- "properties": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "key": {
- "maxLength": 400,
- "minLength": 1,
- "type": "string"
- },
- "label": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "type": {
- "enum": ["event", "person"],
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "maxLength": 4000,
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "maxItems": 100,
- "type": "array"
- },
- {
- "maxLength": 4000,
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["key", "operator", "type"],
- "type": "object"
- },
- "maxItems": 20,
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "description": "Event and person property filters, matching Activity > Explore events."
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["activity_events_list"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
+ "description": {
+ "description": "Optional markdown description shown when show_description is enabled.",
+ "type": "string"
},
- {
+ "layouts": {
+ "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
"properties": {
- "config": {
- "description": "Configuration for the top issues widget.",
+ "sm": {
+ "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
"properties": {
- "assignee": {
- "anyOf": [
- {
- "properties": {
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": {
- "enum": ["user", "role"],
- "type": "string"
- }
- },
- "required": ["id", "type"],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by assignee ({type: user|role, id}). Omit for any assignee."
- },
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of issues to return.",
- "maximum": 25,
- "minimum": 1,
+ "h": {
+ "description": "Height in grid rows.",
"type": "number"
},
- "orderBy": {
- "default": "occurrences",
- "description": "Issue ranking column.",
- "enum": [
- "last_seen",
- "first_seen",
- "occurrences",
- "users",
- "sessions",
- "severity"
- ],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "status": {
- "default": "active",
- "description": "Issue status filter.",
- "enum": [
- "archived",
- "active",
- "resolved",
- "pending_release",
- "suppressed",
- "all"
- ],
- "type": "string"
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["error_tracking_list"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the recent recordings widget.",
- "properties": {
- "collectionId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply."
- },
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of recordings to return.",
- "maximum": 25,
- "minimum": 1,
+ "w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"type": "number"
},
- "orderBy": {
- "default": "start_time",
- "description": "Recording ranking column.",
- "enum": [
- "start_time",
- "activity_score",
- "recording_duration",
- "duration",
- "click_count",
- "console_error_count"
- ],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "savedFilterId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection."
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["session_replay_list"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the experiments list widget.",
- "properties": {
- "createdBy": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by creator (user id). Omit for any creator."
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of experiments to return.",
- "maximum": 25,
- "minimum": 1,
+ "x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
"type": "number"
},
- "orderBy": {
- "default": "created_at",
- "description": "Experiment list sort column.",
- "enum": ["created_at", "name", "start_date"],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "status": {
- "default": "all",
- "description": "Experiment status filter.",
- "enum": ["draft", "running", "paused", "exposure_frozen", "stopped", "all"],
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["experiments_list"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the experiment results widget.",
- "properties": {
- "experimentId": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Experiment to show results for. Null until the user picks one in the widget settings."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["experiment_results"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the survey results widget.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "Null or omitted means all time (the survey's full lifetime)."
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of recent responses to return.",
- "maximum": 25,
- "minimum": 1,
+ "y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
"type": "number"
- },
- "surveyId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Survey to show performance stats and recent responses for. Null until the user picks one."
}
},
"type": "object"
},
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
+ "xs": {
+ "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
"properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["survey_results"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the recent logs widget.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 50,
- "description": "Maximum number of log lines to return.",
- "maximum": 100,
- "minimum": 1,
+ "h": {
+ "description": "Height in grid rows.",
"type": "number"
},
- "orderBy": {
- "default": "latest",
- "description": "Sort by newest (latest) or oldest (earliest) first.",
- "enum": ["latest", "earliest"],
- "type": "string"
- },
- "savedViewId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply."
- },
- "serviceNames": {
- "description": "Only show logs from these services. Empty shows all services.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "severityLevels": {
- "description": "Only show logs at these severity levels. Empty shows all levels.",
- "items": {
- "enum": ["trace", "debug", "info", "warn", "error", "fatal"],
- "type": "string"
- },
- "type": "array"
- },
- "timezone": {
- "default": "UTC",
- "description": "Render log timestamps in UTC or in each viewer's local timezone.",
- "enum": ["UTC", "local"],
- "type": "string"
- },
- "wrapLines": {
- "default": false,
- "description": "Wrap long log lines instead of truncating them to a single row.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["logs_list"],
- "type": "string"
- }
- },
- "required": ["widget_type", "config"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "Configuration for the recent tickets widget.",
- "properties": {
- "assignees": {
- "description": "Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees.",
- "items": {
- "anyOf": [
- {
- "enum": ["me", "unassigned"],
- "type": "string"
- },
- {
- "properties": {
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": {
- "enum": ["user", "role"],
- "type": "string"
- }
- },
- "required": ["id", "type"],
- "type": "object"
- }
- ]
- },
- "maxItems": 100,
- "type": "array"
- },
- "channel": {
- "default": "all",
- "description": "Ticket channel filter.",
- "enum": ["widget", "email", "slack", "teams", "github", "all"],
- "type": "string"
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of tickets to return.",
- "maximum": 25,
- "minimum": 1,
+ "w": {
+ "description": "Width in grid columns. The desktop grid is 12 columns wide.",
"type": "number"
},
- "priorities": {
- "description": "Only show tickets with these priorities. Empty shows all priorities.",
- "items": {
- "enum": ["low", "medium", "high", "critical"],
- "type": "string"
- },
- "type": "array"
- },
- "savedViewId": {
- "anyOf": [
- {
- "maxLength": 12,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit."
- },
- "search": {
- "default": "",
- "description": "Search requester name or email, ticket subject, message text, or ticket number.",
- "maxLength": 200,
- "type": "string"
- },
- "status": {
- "default": "all",
- "description": "Ticket status filter.",
- "enum": ["new", "open", "pending", "on_hold", "resolved", "all"],
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
- "type": "string"
- },
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
+ "x": {
+ "description": "Column position in the dashboard grid (0-indexed).",
+ "type": "number"
},
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
+ "y": {
+ "description": "Row position in the dashboard grid (0-indexed).",
+ "type": "number"
}
},
"type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["conversations_recent_tickets"],
- "type": "string"
}
},
- "required": ["widget_type", "config"],
"type": "object"
},
- {
- "properties": {
- "config": {
- "description": "Configuration for the canvas app widget.",
- "properties": {
- "canvasId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Canvas to render in the tile. Null until the user picks one in the widget settings."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "Optional markdown description shown when show_description is enabled.",
+ "name": {
+ "anyOf": [
+ {
+ "maxLength": 400,
"type": "string"
},
- "layouts": {
- "description": "Optional react-grid-layout positions keyed by breakpoint (sm, xs).",
- "properties": {
- "sm": {
- "description": "Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- },
- "xs": {
- "description": "Layout for the small (mobile) breakpoint, on a 1-column grid. The dashboard derives this layout from the sm order and heights, so a stored xs box does not change what renders.",
- "properties": {
- "h": {
- "description": "Height in grid rows.",
- "type": "number"
- },
- "w": {
- "description": "Width in grid columns. The desktop grid is 12 columns wide.",
- "type": "number"
- },
- "x": {
- "description": "Column position in the dashboard grid (0-indexed).",
- "type": "number"
- },
- "y": {
- "description": "Row position in the dashboard grid (0-indexed).",
- "type": "number"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Optional custom display name for the widget tile."
- },
- "show_description": {
- "description": "Whether to show the description on the dashboard tile.",
- "type": "boolean"
- },
- "widget_type": {
- "enum": ["canvas_app"],
- "type": "string"
+ {
+ "type": "null"
}
- },
- "required": ["widget_type", "config"],
- "type": "object"
+ ],
+ "description": "Optional custom display name for the widget tile."
+ },
+ "show_description": {
+ "description": "Whether to show the description on the dashboard tile.",
+ "type": "boolean"
+ },
+ "widget_type": {
+ "description": "Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
+ "enum": [
+ "activity_events_list",
+ "canvas_app",
+ "conversations_recent_tickets",
+ "error_tracking_list",
+ "experiment_results",
+ "experiments_list",
+ "logs_list",
+ "notebook_widget",
+ "session_replay_list",
+ "survey_results"
+ ],
+ "type": "string"
}
- ]
+ },
+ "required": ["widget_type", "config"],
+ "type": "object"
},
"maxItems": 10,
"minItems": 1,
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
index 89a7f7597fb9..07ecd70f34a4 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
@@ -8,1316 +8,54 @@
"widgets": {
"description": "Widget tiles to update atomically, each identified by its tile_id. config shape is per widget_type; see dashboard-widget-catalog-list for per-type config_schema (1–10 per request).",
"items": {
- "anyOf": [
- {
- "properties": {
- "config": {
- "description": "New configuration for the notebook widget widget. Omit to leave unchanged.",
- "properties": {
- "notebookShortId": {
- "anyOf": [
- {
- "maxLength": 128,
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Source notebook short ID."
- },
- "snapshotId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Immutable notebook widget snapshot. Add one from a notebook widget's menu."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["notebook_widget"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "New configuration for the recent events widget. Omit to leave unchanged.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "eventName": {
- "anyOf": [
- {
- "minLength": 1,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Limit the feed to a single event name. Omit or null for all events."
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 25,
- "description": "Maximum number of events to return.",
- "maximum": 50,
- "minimum": 1,
- "type": "number"
- },
- "properties": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "key": {
- "maxLength": 400,
- "minLength": 1,
- "type": "string"
- },
- "label": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "type": {
- "enum": ["event", "person"],
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "maxLength": 4000,
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "maxItems": 100,
- "type": "array"
- },
- {
- "maxLength": 4000,
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["key", "operator", "type"],
- "type": "object"
- },
- "maxItems": 20,
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "description": "Event and person property filters, matching Activity > Explore events."
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["activity_events_list"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "New configuration for the top issues widget. Omit to leave unchanged.",
- "properties": {
- "assignee": {
- "anyOf": [
- {
- "properties": {
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": {
- "enum": ["user", "role"],
- "type": "string"
- }
- },
- "required": ["id", "type"],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by assignee ({type: user|role, id}). Omit for any assignee."
- },
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of issues to return.",
- "maximum": 25,
- "minimum": 1,
- "type": "number"
- },
- "orderBy": {
- "default": "occurrences",
- "description": "Issue ranking column.",
- "enum": [
- "last_seen",
- "first_seen",
- "occurrences",
- "users",
- "sessions",
- "severity"
- ],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "status": {
- "default": "active",
- "description": "Issue status filter.",
- "enum": [
- "archived",
- "active",
- "resolved",
- "pending_release",
- "suppressed",
- "all"
- ],
- "type": "string"
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["error_tracking_list"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "New configuration for the recent recordings widget. Omit to leave unchanged.",
- "properties": {
- "collectionId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a session replay collection to scope the widget to its pinned recordings. Combine with savedFilterId or property filters to narrow within the collection; orderBy, orderDirection, and limit still apply."
- },
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "filterTestAccounts": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of recordings to return.",
- "maximum": 25,
- "minimum": 1,
- "type": "number"
- },
- "orderBy": {
- "default": "start_time",
- "description": "Recording ranking column.",
- "enum": [
- "start_time",
- "activity_score",
- "recording_duration",
- "duration",
- "click_count",
- "console_error_count"
- ],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "savedFilterId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved session replay filter to refine the recordings shown. When set, the saved filter owns the date range and property filters; only orderBy, orderDirection, and limit still apply. Combine with collectionId to filter within a collection."
- },
- "widgetFilters": {
- "anyOf": [
- {
- "additionalProperties": {
- "properties": {
- "filterId": {
- "minLength": 1,
- "type": "string"
- },
- "operator": {
- "enum": [
- "exact",
- "is_not",
- "icontains",
- "not_icontains",
- "starts_with",
- "not_starts_with",
- "ends_with",
- "not_ends_with",
- "regex",
- "not_regex",
- "gt",
- "gte",
- "lt",
- "lte",
- "is_set",
- "is_not_set",
- "is_date_exact",
- "is_date_before",
- "is_date_after",
- "between",
- "not_between",
- "min",
- "max",
- "in",
- "not_in",
- "is_cleaned_path_exact",
- "is_cleaned_path_not_exact",
- "flag_evaluates_to",
- "semver_eq",
- "semver_neq",
- "semver_gt",
- "semver_gte",
- "semver_lt",
- "semver_lte",
- "semver_tilde",
- "semver_caret",
- "semver_wildcard",
- "icontains_multi",
- "not_icontains_multi"
- ],
- "type": "string"
- },
- "optionId": {
- "minLength": 1,
- "type": "string"
- },
- "propertyName": {
- "minLength": 1,
- "type": "string"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": ["filterId", "propertyName", "optionId", "operator"],
- "type": "object"
- },
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["session_replay_list"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "New configuration for the experiments list widget. Omit to leave unchanged.",
- "properties": {
- "createdBy": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Filter by creator (user id). Omit for any creator."
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of experiments to return.",
- "maximum": 25,
- "minimum": 1,
- "type": "number"
- },
- "orderBy": {
- "default": "created_at",
- "description": "Experiment list sort column.",
- "enum": ["created_at", "name", "start_date"],
- "type": "string"
- },
- "orderDirection": {
- "default": "DESC",
- "description": "Sort direction for orderBy.",
- "enum": ["ASC", "DESC"],
- "type": "string"
- },
- "status": {
- "default": "all",
- "description": "Experiment status filter.",
- "enum": ["draft", "running", "paused", "exposure_frozen", "stopped", "all"],
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["experiments_list"],
- "type": "string"
- }
+ "properties": {
+ "config": {
+ "additionalProperties": {},
+ "description": "Widget configuration as a JSON object. Its keys depend on widget_type: read that type's config_schema from dashboard-widget-catalog-list. The API validates the config and returns a 400 that names each invalid field. Each top-level key you send replaces the stored value, and keys you leave out stay as they are. Omit config to leave it unchanged.",
+ "propertyNames": {
+ "type": "string"
},
- "required": ["tile_id", "widget_type"],
"type": "object"
},
- {
- "properties": {
- "config": {
- "description": "New configuration for the experiment results widget. Omit to leave unchanged.",
- "properties": {
- "experimentId": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Experiment to show results for. Null until the user picks one in the widget settings."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["experiment_results"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
+ "description": {
+ "description": "New markdown description for the widget. Omit to leave unchanged.",
+ "type": "string"
},
- {
- "properties": {
- "config": {
- "description": "New configuration for the survey results widget. Omit to leave unchanged.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "Null or omitted means all time (the survey's full lifetime)."
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of recent responses to return.",
- "maximum": 25,
- "minimum": 1,
- "type": "number"
- },
- "surveyId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Survey to show performance stats and recent responses for. Null until the user picks one."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
+ "name": {
+ "anyOf": [
+ {
+ "maxLength": 400,
"type": "string"
},
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["survey_results"],
- "type": "string"
+ {
+ "type": "null"
}
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
+ ],
+ "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
},
- {
- "properties": {
- "config": {
- "description": "New configuration for the recent logs widget. Omit to leave unchanged.",
- "properties": {
- "dateRange": {
- "anyOf": [
- {
- "properties": {
- "date_from": {
- "anyOf": [
- {
- "enum": [
- "-1M",
- "-30M",
- "-1h",
- "-3h",
- "-24h",
- "-7d",
- "-14d",
- "-30d",
- "-90d"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "limit": {
- "default": 50,
- "description": "Maximum number of log lines to return.",
- "maximum": 100,
- "minimum": 1,
- "type": "number"
- },
- "orderBy": {
- "default": "latest",
- "description": "Sort by newest (latest) or oldest (earliest) first.",
- "enum": ["latest", "earliest"],
- "type": "string"
- },
- "savedViewId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved logs view to use as the source. When set, the saved view owns the date range, severity, service, and property filters; only orderBy and limit still apply."
- },
- "serviceNames": {
- "description": "Only show logs from these services. Empty shows all services.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "severityLevels": {
- "description": "Only show logs at these severity levels. Empty shows all levels.",
- "items": {
- "enum": ["trace", "debug", "info", "warn", "error", "fatal"],
- "type": "string"
- },
- "type": "array"
- },
- "timezone": {
- "default": "UTC",
- "description": "Render log timestamps in UTC or in each viewer's local timezone.",
- "enum": ["UTC", "local"],
- "type": "string"
- },
- "wrapLines": {
- "default": false,
- "description": "Wrap long log lines instead of truncating them to a single row.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["logs_list"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
- },
- {
- "properties": {
- "config": {
- "description": "New configuration for the recent tickets widget. Omit to leave unchanged.",
- "properties": {
- "assignees": {
- "description": "Only show tickets assigned to these users or roles. 'me' means the requesting user and 'unassigned' means tickets without an assignment. Empty shows all assignees.",
- "items": {
- "anyOf": [
- {
- "enum": ["me", "unassigned"],
- "type": "string"
- },
- {
- "properties": {
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": {
- "enum": ["user", "role"],
- "type": "string"
- }
- },
- "required": ["id", "type"],
- "type": "object"
- }
- ]
- },
- "maxItems": 100,
- "type": "array"
- },
- "channel": {
- "default": "all",
- "description": "Ticket channel filter.",
- "enum": ["widget", "email", "slack", "teams", "github", "all"],
- "type": "string"
- },
- "limit": {
- "default": 10,
- "description": "Maximum number of tickets to return.",
- "maximum": 25,
- "minimum": 1,
- "type": "number"
- },
- "priorities": {
- "description": "Only show tickets with these priorities. Empty shows all priorities.",
- "items": {
- "enum": ["low", "medium", "high", "critical"],
- "type": "string"
- },
- "type": "array"
- },
- "savedViewId": {
- "anyOf": [
- {
- "maxLength": 12,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "short_id of a saved Support view to use as the source. When set, the saved view owns the ticket filters; the widget still sorts by most recently updated and applies its limit."
- },
- "search": {
- "default": "",
- "description": "Search requester name or email, ticket subject, message text, or ticket number.",
- "maxLength": 200,
- "type": "string"
- },
- "status": {
- "default": "all",
- "description": "Ticket status filter.",
- "enum": ["new", "open", "pending", "on_hold", "resolved", "all"],
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["conversations_recent_tickets"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
+ "tile_id": {
+ "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
+ "type": "number"
},
- {
- "properties": {
- "config": {
- "description": "New configuration for the canvas app widget. Omit to leave unchanged.",
- "properties": {
- "canvasId": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Canvas to render in the tile. Null until the user picks one in the widget settings."
- }
- },
- "type": "object"
- },
- "description": {
- "description": "New markdown description for the widget. Omit to leave unchanged.",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "maxLength": 400,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "New display name for the widget. Empty string or null clears it; omit to leave unchanged."
- },
- "tile_id": {
- "description": "ID of the widget tile to update. Use dashboard-get to look up widget tile IDs.",
- "type": "number"
- },
- "widget_type": {
- "enum": ["canvas_app"],
- "type": "string"
- }
- },
- "required": ["tile_id", "widget_type"],
- "type": "object"
+ "widget_type": {
+ "description": "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
+ "enum": [
+ "activity_events_list",
+ "canvas_app",
+ "conversations_recent_tickets",
+ "error_tracking_list",
+ "experiment_results",
+ "experiments_list",
+ "logs_list",
+ "notebook_widget",
+ "session_replay_list",
+ "survey_results"
+ ],
+ "type": "string"
}
- ]
+ },
+ "required": ["tile_id"],
+ "type": "object"
},
"maxItems": 10,
"minItems": 1,
diff --git a/services/mcp/tests/unit/tool-schema-snapshots.test.ts b/services/mcp/tests/unit/tool-schema-snapshots.test.ts
index e239fa38bcae..de6cbedff36c 100644
--- a/services/mcp/tests/unit/tool-schema-snapshots.test.ts
+++ b/services/mcp/tests/unit/tool-schema-snapshots.test.ts
@@ -153,7 +153,7 @@ describe('Tool schema snapshots', () => {
describe('schema budgets', () => {
// Ratchet: the number of oversized tool schemas may only go down.
- const OVERSIZED_SCHEMA_COUNT = 43
+ const OVERSIZED_SCHEMA_COUNT = 41
// Ratchet: the share of nested properties with a description may only go up.
const NESTED_DESCRIPTION_COVERAGE_FLOOR_PERCENT = 55