Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#79557)

github-automation-metabase55e63c2b6f3c
diff --git a/docs/api.json b/docs/api.json
index 7d38db07246..d82609517cf 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -5324,7 +5324,7 @@
},
"metabase.collections.schema.CollectionItemModel" : {
"type" : "string",
- "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "table" ]
+ "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "exploration", "table" ]
},
"metabase.collections.schema.CollectionType" : {
"type" : "string",
@@ -5576,6 +5576,744 @@
},
"required" : [ "id", "entity_id", "name", "settings", "created_at", "updated_at" ]
},
+ "metabase.explorations.api.CanceledThread" : {
+ "description" : "Schema for the cancel endpoint response — just the state-bearing fields the FE needs to\n reflect the cancellation. EQ status changes are picked up via the existing `/queries` poll.",
+ "type" : "object",
+ "properties" : {
+ "canceled_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "canceled_at", "completed_at" ]
+ },
+ "metabase.explorations.api.DimensionsResponse" : {
+ "description" : "Schema for GET /dimensions: metrics referencing dimensions by id, plus the grouped dimension list.",
+ "type" : "object",
+ "properties" : {
+ "dimension_groups" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationDimensionGroup"
+ }
+ },
+ "metrics" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationMetric"
+ }
+ }
+ },
+ "required" : [ "metrics", "dimension_groups" ]
+ },
+ "metabase.explorations.api.ExplorationBlockNode" : {
+ "description" : "A block (the FE's sidebar group): a heading plus its pages. `:type` is whether the block is\n anchored on its metric or its dimension; `:name` is the computed heading (the metric name, or\n `By <dimension>`). `:position` is the block's 0-indexed authoring slot.",
+ "type" : "object",
+ "properties" : {
+ "explore_filters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "value" : { }
+ },
+ "required" : [ "field_ref", "value" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pages" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationPageNode"
+ }
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "metric", "dimension" ]
+ }
+ },
+ "required" : [ "id", "type", "name", "position", "pages" ]
+ },
+ "metabase.explorations.api.ExplorationDimensionGroup" : {
+ "description" : "Schema for a dimension group in the /dimensions response. A group bundles together dimensions that\n refer to the same underlying source (same field/binning) so the FE can show a single user-facing\n entry while still tracking the actual per-metric dimensions needed by `start exploration`.",
+ "type" : "object",
+ "properties" : {
+ "dimension_interestingness" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimensions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension"
+ }
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "dimension_interestingness", "dimensions" ]
+ },
+ "metabase.explorations.api.ExplorationMetric" : {
+ "description" : "Schema for a metric in the /dimensions response: dimensions referenced by id only.",
+ "type" : "object",
+ "properties" : {
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension-mapping"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_column_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension_ids" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "in_library" : {
+ "type" : "boolean"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "description", "collection_id", "dimension_ids" ]
+ },
+ "metabase.explorations.api.ExplorationPageNode" : {
+ "description" : "A page within a block: the bundle of queries for one (card, dimension, query_type) under the\n page's stable id. `:query_ids` reference queries on the same thread, sorted by interestingness.\n `:position` is the page's 0-indexed slot among its block's pages. `:name` is the page's short,\n heading-relative label (e.g. `By Category over time`); `:long_name` is the full\n self-describing name (e.g. `Number of Orders by Category over time`) for use without the block\n heading for context.",
+ "type" : "object",
+ "properties" : {
+ "hidden" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "long_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "query_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "starred" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id", "name", "long_name", "position", "query_ids", "starred", "hidden" ]
+ },
+ "metabase.explorations.api.ExplorationQueryStreamResponse" : {
+ "description" : "Schema for `GET /query/:id`. On success the body is a streamed dataset (api/csv/json/xlsx),\n so we describe it as `:any`. On a not-yet-done query we return a 409 with a status payload.",
+ "anyOf" : [ { }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "finished_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "status" ]
+ },
+ "status" : {
+ "const" : 409
+ }
+ },
+ "required" : [ "status", "body" ]
+ } ]
+ },
+ "metabase.explorations.api.ExplorationQuerySummary" : {
+ "description" : "Schema for a query row in API responses. The result blob and `dataset_query` aren't\n asserted here; `interestingness_score`, `contextual_interestingness_score`, and `row_count`\n are batched-hydrated onto each query in `/:id` — the scores from `exploration_query_result`,\n `row_count` from the linked `stored_result` — and may be nil for pending/errored queries or —\n for the contextual score — when the LLM is unconfigured or the thread had no prompt.",
+ "type" : "object",
+ "properties" : {
+ "exploration_thread_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "segment_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row_count" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "contextual_interestingness_score" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "interestingness_score" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "card_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query_type" : {
+ "type" : "string"
+ },
+ "segment_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension_name" : {
+ "type" : "string"
+ },
+ "finished_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "exploration_thread_id", "card_id", "dimension_id", "query_type", "position", "status" ]
+ },
+ "metabase.explorations.api.ExplorationSummary" : {
+ "description" : "Lightweight row for the `GET /mine` list. No threads/queries — just the metadata\n needed to render a list entry, plus `current_user_last_touched_at`, the timestamp the list is\n sorted by (the caller's own most-recent touch of this exploration, composed across the\n exploration's revisions and its creation).",
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "id", "name" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "email" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "current_user_last_touched_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "creator_id", "created_at", "updated_at", "current_user_last_touched_at" ]
+ },
+ "metabase.explorations.api.HydratedExploration" : {
+ "description" : "Schema for an Exploration with hydrated creator and threads.",
+ "type" : "object",
+ "properties" : {
+ "threads" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedThread"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "creator_id" ]
+ },
+ "metabase.explorations.api.HydratedThread" : {
+ "description" : "Schema for an Exploration thread with hydrated selections and queries.",
+ "type" : "object",
+ "properties" : {
+ "queries" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationQuerySummary"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "blocks" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationBlockNode"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "pending", "running", "canceled", "empty", "failed", "completed" ]
+ },
+ "source_page_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "prompt" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timelines" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "position" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "timeline" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "timeline_id" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "exploration_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "canceled_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "exploration_id", "position", "status" ]
+ },
+ "metabase.explorations.api.MineResponse" : {
+ "description" : "Paginated envelope for `GET /mine`, mirroring the collection-items index shape. `:total` is the\n count after the membership, permission, and archived filters; `:limit`/`:offset` echo the\n `offset-paging` middleware (both nil when the request is unpaged).",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationSummary"
+ }
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "offset" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "total", "limit", "offset", "data" ]
+ },
"metabase.frontend-errors.api.frontend-error-type" : {
"type" : "string",
"enum" : [ "component-crash", "chart-render-error" ]
@@ -8361,6 +9099,10 @@
}
}
},
+ "metabase.lib-metric.schema..dimension-source.type" : {
+ "type" : "string",
+ "enum" : [ "field" ]
+ },
"metabase.lib-metric.schema.binning" : {
"description" : "Schema for `:binning` options passed to a `:dimension` clause.",
"allOf" : [ {
@@ -8425,6 +9167,11 @@
"$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
} ]
},
+ "metabase.lib-metric.schema.dimension-status" : {
+ "description" : "Status of a dimension indicating whether it's active or has issues.\n - :status/active - Column exists, dimension is usable\n - :status/orphaned - Column was removed from schema, dimension preserved for reference",
+ "type" : "string",
+ "enum" : [ "status/active", "status/orphaned" ]
+ },
"metabase.lib-metric.schema.expression-leaf" : {
"description" : "A leaf node in a metric math expression: either a metric or measure reference.",
"anyOf" : [ {
@@ -9147,7 +9894,7 @@
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot" ]
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot", "exploration" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
@@ -12093,15 +12840,10 @@
"type" : "object",
"properties" : {
"dimension_mappings" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension-mapping"
+ }
},
"collection" : {
"oneOf" : [ {
@@ -12145,15 +12887,10 @@
"type" : "string"
},
"dimensions" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
+ }
},
"database_id" : {
"oneOf" : [ {
@@ -12181,7 +12918,7 @@
} ]
}
},
- "required" : [ "id", "name", "description", "collection_id" ]
+ "required" : [ "id", "name", "description", "collection_id", "dimensions", "dimension_mappings" ]
},
"metabase.metrics.api.RemappedValueResponse" : {
"description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
@@ -12195,6 +12932,175 @@
} ]
} ]
},
+ "metabase.metrics.core.dimension" : {
+ "description" : "A metric dimension in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension]].",
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension"
+ },
+ "metabase.metrics.core.dimension-mapping" : {
+ "description" : "A dimension mapping in its internal kebab-case shape, annotated with the rules that convert it to\n and from the snake_case wire shape. See [[metabase.metrics.dimension/dimension-mapping]].",
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.dimension-mapping"
+ },
+ "metabase.metrics.dimension.dimension" : {
+ "description" : "Schema for a persisted dimension definition with status tracking.\n Persisted dimensions include additional metadata about their status\n and any issues that prevent them from being used.\n Note: target field references are stored in dimension-mappings, not here.",
+ "type" : "object",
+ "properties" : {
+ "sources" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.source"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "group" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metrics.dimension.group"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-status"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has-field-values" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status-message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default-temporal-unit" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension-interestingness" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id" ]
+ },
+ "metabase.metrics.dimension.dimension-mapping" : {
+ "description" : "Schema for a dimension mapping.",
+ "type" : "object",
+ "properties" : {
+ "dimension-id" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
+ },
+ "table-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : { },
+ "type" : {
+ "description" : "Type of dimension mapping.",
+ "type" : "string",
+ "enum" : [ "table" ]
+ }
+ },
+ "required" : [ "dimension-id", "target" ]
+ },
+ "metabase.metrics.dimension.group" : {
+ "description" : "Group descriptor for a dimension, indicating which table it belongs to.",
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "main", "connection" ]
+ }
+ },
+ "required" : [ "id", "type", "display-name" ]
+ },
+ "metabase.metrics.dimension.source" : {
+ "description" : "A dimension source annotated with its wire-encoding rules. Quirks preserved from the previous\n hand-rolled shape: entries keep their kebab-case `:field-id` key on the wire (no key renaming),\n `:field-id` is always present (nil when missing), and other keys (e.g. `:binning`) are dropped.",
+ "type" : "object",
+ "properties" : {
+ "field-id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-source.type"
+ }
+ },
+ "required" : [ "type" ]
+ },
"metabase.notification.api.admin.bulk-response" : {
"type" : "object",
"properties" : {
@@ -17554,7 +18460,7 @@
},
"type" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
},
"required" : [ "type", "item_id" ]
@@ -17580,7 +18486,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
}, {
"in" : "path",
@@ -17615,7 +18521,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "card", "dashboard", "collection", "document" ]
+ "enum" : [ "card", "dashboard", "collection", "document", "exploration" ]
}
}, {
"in" : "path",
@@ -19765,7 +20671,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -20293,7 +21199,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "no_models", "timeline", "snippet", "collection", "measure", "transform", "document", "pulse", "metric", "card" ]
}
}, {
"type" : "null"
@@ -20468,7 +21374,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "document" ]
+ "enum" : [ "document", "exploration" ]
}
}, {
"in" : "query",
@@ -20525,6 +21431,13 @@
"content" : {
"type" : "object"
},
+ "context" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
"parent_comment_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -20541,7 +21454,7 @@
},
"target_type" : {
"type" : "string",
- "enum" : [ "document" ]
+ "enum" : [ "document", "exploration" ]
}
},
"required" : [ "target_type", "target_id", "content" ]
@@ -33969,32 +34882,319 @@
}
}
},
- "tags" : [ "/api/embed-theme" ]
- },
- "delete" : {
- "operationId" : "delete-api-embed-theme-id",
- "summary" : "DELETE /api/embed-theme/{id}",
- "description" : "Delete an embedding theme.",
+ "tags" : [ "/api/embed-theme" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-embed-theme-id",
+ "summary" : "DELETE /api/embed-theme/{id}",
+ "description" : "Delete an embedding theme.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed-theme/{id}/copy" : {
+ "post" : {
+ "operationId" : "post-api-embed-theme-id-copy",
+ "summary" : "POST /api/embed-theme/{id}/copy",
+ "description" : "Copy an embedding theme.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed/card/{token}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token",
+ "summary" : "GET /api/embed/card/{token}",
+ "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "description" : "Embedded version of chain filter search endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/values" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-values",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-query",
+ "summary" : "GET /api/embed/card/{token}/query",
+ "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query/{export-format}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-query-export-format",
+ "summary" : "GET /api/embed/card/{token}/query/{export-format}",
+ "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
+ "in" : "query",
+ "name" : "format_rows",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token",
+ "summary" : "GET /api/embed/dashboard/{token}",
+ "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34003,17 +35203,33 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed-theme" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/embed-theme/{id}/copy" : {
- "post" : {
- "operationId" : "post-api-embed-theme-id-copy",
- "summary" : "POST /api/embed-theme/{id}/copy",
- "description" : "Copy an embedding theme.",
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -34023,14 +35239,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34039,14 +35248,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed-theme" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}" : {
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
"get" : {
- "operationId" : "get-api-embed-card-token",
- "summary" : "GET /api/embed/card/{token}",
- "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34054,6 +35263,47 @@
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
+ "in" : "query",
+ "name" : "format_rows",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
@@ -34069,11 +35319,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-remapping",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of the remapped dashboard param value endpoint.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34089,13 +35339,6 @@
"type" : "string",
"minLength" : 1
}
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
@@ -34111,10 +35354,10 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
"in" : "path",
@@ -34154,11 +35397,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/values" : {
+ "/api/embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-values",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
- "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
+ "description" : "Embedded version of chain filter values endpoint.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34189,10 +35432,10 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/query" : {
+ "/api/embed/pivot/card/{token}/query" : {
"get" : {
- "operationId" : "get-api-embed-card-token-query",
- "summary" : "GET /api/embed/card/{token}/query",
+ "operationId" : "get-api-embed-pivot-card-token-query",
+ "summary" : "GET /api/embed/pivot/card/{token}/query",
"description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
"parameters" : [ {
"in" : "path",
@@ -34216,11 +35459,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/card/{token}/query/{export-format}" : {
+ "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "operationId" : "get-api-embed-card-token-query-export-format",
- "summary" : "GET /api/embed/card/{token}/query/{export-format}",
- "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34230,27 +35473,22 @@
}
}, {
"in" : "path",
- "name" : "export-format",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- }, {
- "in" : "query",
- "name" : "format_rows",
- "required" : false,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
- "in" : "query",
- "name" : "pivot_results",
- "required" : false,
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -34266,11 +35504,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/dashboard/{token}" : {
+ "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token",
- "summary" : "GET /api/embed/dashboard/{token}",
- "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
+ "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34278,6 +35516,52 @@
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -34293,11 +35577,11 @@
"tags" : [ "/api/embed" ]
}
},
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
"in" : "path",
"name" : "token",
@@ -34323,10 +35607,310 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/eval-trace/{session-id}" : {
+ "get" : {
+ "operationId" : "get-api-eval-trace-session-id",
+ "summary" : "GET /api/eval-trace/{session-id}",
+ "description" : "Return the captured eval trace as JSONL (one span per line) for `session-id`. Superuser-only;\n served only when `MB_AI_EVAL_CAPTURE` is enabled.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "session-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 200
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : { }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/eval-trace" ]
+ }
+ },
+ "/api/exploration" : {
+ "post" : {
+ "operationId" : "post-api-exploration",
+ "summary" : "POST /api/exploration",
+ "description" : "Create a new exploration with a single thread, persist the user's selected metrics, dimensions,\n and timelines, and stamp the thread as started. Actual planning is async; this endpoint returns\n immediately with an empty queries list. Clients should poll `GET /:id` until the queries appear\n and reach a terminal status.\n\n Accepts the per-area `:blocks` payload (one entry per Research-plan block), persisted\n verbatim, plus a thread-scoped `:timeline_ids`.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "blocks" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimension-id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "dimension-id" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metrics" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.core.dimension-mapping"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "card_id" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "metric", "dimension" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 254
+ },
+ "prompt" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_ids" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/dimensions" : {
+ "get" : {
+ "operationId" : "get-api-exploration-dimensions",
+ "summary" : "GET /api/exploration/dimensions",
+ "description" : "Hydrated metrics plus a deduplicated dimension list, for the Exploration data modal.\n\n Optional `q` filters case-insensitively across metric name and dimension display-name.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.DimensionsResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/exploration" ]
+ }
+ },
+ "/api/exploration/mine" : {
+ "get" : {
+ "operationId" : "get-api-exploration-mine",
+ "summary" : "GET /api/exploration/mine",
+ "description" : "Explorations the current user created or edited, most-recently-touched first, paginated.\n\n \"Touched\" composes the user's own edits to the exploration and its creation — see\n [[my-explorations-honeysql]]. Explorations that were moved into a collection the user can no\n longer read are excluded, as are archived ones. Returns the collection-items envelope:\n `{:total :limit :offset :data}`.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.MineResponse"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34335,66 +35919,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
+ "/api/exploration/page/{id}/starred" : {
+ "put" : {
+ "operationId" : "put-api-exploration-page-id-starred",
+ "summary" : "PUT /api/exploration/page/{id}/starred",
+ "description" : "Set whether an exploration page is starred.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- }, {
- "in" : "query",
- "name" : "format_rows",
- "required" : false,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "pivot_results",
- "required" : false,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34403,33 +35955,40 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "starred" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "starred" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of the remapped dashboard param value endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "/api/exploration/pages/hidden" : {
+ "put" : {
+ "operationId" : "put-api-exploration-pages-hidden",
+ "summary" : "PUT /api/exploration/pages/hidden",
+ "description" : "Set whether one or more exploration pages are hidden from the sidebar. Hiding a single\n page passes a one-element `page_ids`; hiding a whole group passes all its page ids.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34438,41 +35997,66 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "hidden" : {
+ "type" : "boolean"
+ },
+ "page_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "page_ids", "hidden" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/exploration/query/{id}" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
- "description" : "Embedded version of chain filter search endpoint.",
+ "operationId" : "get-api-exploration-query-id",
+ "summary" : "GET /api/exploration/query/{id}",
+ "description" : "Stream the result of a single completed exploration query. The optional `format` query param\n is one of `api`, `json`, `csv`, `xlsx` (default `api`). When the underlying query is still\n pending or has errored, returns a 409 with status info instead of streaming.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
+ "in" : "query",
+ "name" : "format",
+ "required" : false,
"schema" : {
+ "default" : "api",
"type" : "string",
- "minLength" : 1
+ "enum" : [ "api", "csv", "json", "xlsx" ]
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.ExplorationQueryStreamResponse"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34481,33 +36065,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/values" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
- "description" : "Embedded version of chain filter values endpoint.",
+ "/api/exploration/thread/{thread-id}/cancel" : {
+ "post" : {
+ "operationId" : "post-api-exploration-thread-thread-id-cancel",
+ "summary" : "POST /api/exploration/thread/{thread-id}/cancel",
+ "description" : "Cancel an in-flight exploration thread. Stamps `canceled_at` and `completed_at` on the thread,\n and bulk-flips any still-`pending` ExplorationQuery rows to `canceled`. In-flight queries\n currently mid-QP-execution are left to run to natural completion — their result rows are\n orphaned but harmless (timeline scoring skips canceled threads).\n\n Idempotent: a thread with `completed_at IS NOT NULL` (already terminal — natural completion or\n prior cancel) returns 200 with its existing state. Authorization is the same write check as\n other thread-mutating endpoints.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "thread-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.CanceledThread"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34516,25 +36101,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/pivot/card/{token}/query" : {
- "get" : {
- "operationId" : "get-api-embed-pivot-card-token-query",
- "summary" : "GET /api/embed/pivot/card/{token}/query",
- "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
+ "/api/exploration/thread/{thread-id}/restart" : {
+ "post" : {
+ "operationId" : "post-api-exploration-thread-thread-id-restart",
+ "summary" : "POST /api/exploration/thread/{thread-id}/restart",
+ "description" : "Re-run one exploration thread in place, keeping its selections: drops the thread's materialized\n queries and clears the terminal-state gates so the background planner re-claims it. Returns the\n parent exploration. Only a terminal thread (completed, failed, or canceled) can restart; while\n planning, execution, or analysis is still in flight this returns a 409 — cancel the thread\n first, then restart.\n\n No `:event/exploration-update` is published: nothing on the Exploration row changes, so there\n is no revision to record (the revision push skips unchanged objects).",
"parameters" : [ {
"in" : "path",
- "name" : "token",
+ "name" : "thread-id",
"required" : true,
"schema" : {
- "type" : "string"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34543,33 +36137,17 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/exploration/{id}" : {
"get" : {
- "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "operationId" : "get-api-exploration-id",
+ "summary" : "GET /api/exploration/{id}",
+ "description" : "Fetch an exploration with its thread, selections, and generated queries.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -34579,7 +36157,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34588,71 +36173,32 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
- "get" : {
- "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
- "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "tags" : [ "/api/exploration" ]
+ },
+ "put" : {
+ "operationId" : "put-api-exploration-id",
+ "summary" : "PUT /api/exploration/{id}",
+ "description" : "Update an exploration's metadata, archive state, or move it to a different collection.\n\n When `collection_id` changes, the caller must have write perms on the destination collection\n (or the root collection when `collection_id` is nil). Source perms are enforced by\n `api/write-check` against the exploration itself via `:perms/use-parent-collection-perms`.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "y",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be a valid JSON string."
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34661,89 +36207,76 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
- "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "archived" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 254
+ }
+ }
+ }
+ }
}
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
+ },
+ "tags" : [ "/api/exploration" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-exploration-id",
+ "summary" : "DELETE /api/exploration/{id}",
+ "description" : "Hard-delete an exploration. Soft delete is `PUT /api/exploration/:id {archived: true}`.\n\n Cascades to every `exploration_thread` and `exploration_query` via the on-delete-cascade\n FKs configured in the explorations migration.",
+ "parameters" : [ {
"in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "y",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- },
- "description" : "value must be a valid JSON string."
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34752,30 +36285,32 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/exploration" ]
}
},
- "/api/eval-trace/{session-id}" : {
- "get" : {
- "operationId" : "get-api-eval-trace-session-id",
- "summary" : "GET /api/eval-trace/{session-id}",
- "description" : "Return the captured eval trace as JSONL (one span per line) for `session-id`. Superuser-only;\n served only when `MB_AI_EVAL_CAPTURE` is enabled.",
+ "/api/exploration/{id}/explore-further" : {
+ "post" : {
+ "operationId" : "post-api-exploration-id-explore-further",
+ "summary" : "POST /api/exploration/{id}/explore-further",
+ "description" : "Start a follow-up investigation scoped to a clicked chart segment.\n\n The user clicked a bar/point on the chart for `page_id`; we copy that page's block (its metric\n selection + the same dimensions) into a brand-new thread and append each `explore_filters`\n entry onto every metric selection's `:explore_filters` vector. The background planner then\n materializes the same set of charts, but every query is scoped to those filters — and to any\n filters the source block already carried, so drilling from within an already-drilled thread\n keeps the earlier scope (see\n `metabase.explorations.query-plan.context/build-row-context`). Returns immediately with the new\n thread stamped `started_at`; clients poll `GET /:id` for the queries to land, exactly like create.",
"parameters" : [ {
"in" : "path",
- "name" : "session-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 200
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
- "schema" : { }
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.explorations.api.HydratedExploration"
+ }
}
}
},
@@ -34786,7 +36321,53 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/eval-trace" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "explore_filters" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "dimension_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_value" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_ref" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "value" : { }
+ },
+ "required" : [ "field_ref", "value" ]
+ },
+ "minItems" : 1
+ },
+ "page_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "page_id", "explore_filters" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/exploration" ]
}
},
"/api/field/table-ids" : {
@@ -38911,7 +40492,7 @@
"get" : {
"operationId" : "get-api-metric-id",
"summary" : "GET /api/metric/{id}",
- "description" : "Fetch a `Metric` with ID.\n\n Returns the metric with hydrated dimensions and dimension mappings.",
+ "description" : "Fetch a `Metric` with ID.\n\n Returns the metric with hydrated dimensions and dimension mappings; the `::MetricWithDimensions`\n schema encodes them to the snake_case wire shape at the `defendpoint` edge.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -44870,7 +46451,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"type" : "null"
@@ -45191,7 +46772,7 @@
"type" : "array",
"items" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"type" : "null"
@@ -45431,7 +47012,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
+ "enum" : [ "dashboard", "table", "exploration", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}, {
"in" : "query",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index ecdaa0f3ad1..e223425a329 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -155,6 +155,7 @@ config:
enable-pivoted-exports: true
enable-public-sharing: true
enable-xrays: true
+ explorations-worker-count: 2
fingerprint-max-fields-per-table: 10000
follow-up-email-sent: false
google-auth-auto-create-accounts-domain: null
@@ -216,7 +217,7 @@ config:
llm-bedrock-region: us-east-1
llm-bedrock-secret-access-key: null
llm-bedrock-session-token: null
- llm-connection-timeout-ms: 5000
+ llm-connection-timeout-ms: 10000
llm-max-tokens: 4096
llm-metabot-provider: anthropic/claude-sonnet-4-6
llm-mistral-api-base-url: https://api.mistral.ai/v1
@@ -228,7 +229,7 @@ config:
llm-openrouter-api-key: null
llm-rate-limit-per-ip: 100
llm-rate-limit-per-user: 20
- llm-request-timeout-ms: 60000
+ llm-request-timeout-ms: 120000
llm-zai-api-base-url: https://api.z.ai/api/paas/v4
llm-zai-api-key: null
loading-message: doing-science
@@ -308,7 +309,7 @@ config:
search-typeahead-enabled: true
send-new-sso-user-admin-email: null
session-cookie-samesite: lax
- session-cookies: null
+ session-cookies: false
session-timeout: null
setup-embedding-autoenabled: false
setup-license-active-at-setup: false
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 988d2d2302a..95044467eac 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -785,6 +785,13 @@ Enable admins to create publicly viewable links (and embeddable iframes) for Que
Allow users to explore data using X-rays.
+### `MB_EXPLORATIONS_WORKER_COUNT`
+
+- Type: integer
+- Default: `2`
+
+How many exploration queries a single Metabase node runs at once.
+
### `MB_FINGERPRINT_MAX_FIELDS_PER_TABLE`
- Type: integer
@@ -1364,10 +1371,10 @@ The AWS Session Token for Amazon Bedrock. Only needed for temporary credentials.
### `MB_LLM_CONNECTION_TIMEOUT_MS`
- Type: integer
-- Default: `5000`
+- Default: `10000`
- [Configuration file name](./config-file.md): `llm-connection-timeout-ms`
-Connection timeout in milliseconds for LLM API requests.
+TCP connection timeout in milliseconds for LLM API requests. A provider that is down or unreachable should fail fast instead of holding a worker thread forever.
### `MB_LLM_MAX_TOKENS`
@@ -1460,10 +1467,10 @@ Maximum SQL generation requests per user per minute.
### `MB_LLM_REQUEST_TIMEOUT_MS`
- Type: integer
-- Default: `60000`
+- Default: `120000`
- [Configuration file name](./config-file.md): `llm-request-timeout-ms`
-Socket timeout in milliseconds for LLM API requests.
+Socket (inter-byte read) timeout in milliseconds for LLM API requests. For streaming responses this bounds the gap between successive chunks, NOT the total response time. Picked generously: extended thinking can pause for tens of seconds between chunks. Without it, a hung read inside the stream blocks the worker indefinitely — observed in production when an upstream proxy held the connection open without sending data.
### `MB_LLM_ZAI_API_BASE_URL`
@@ -2212,7 +2219,7 @@ See [Embedding Metabase in a different domain](../embedding/full-app-embedding.m
### `MB_SESSION_COOKIES`
- Type: boolean
-- Default: `null`
+- Default: `false`
- [Configuration file name](./config-file.md): `session-cookies`
When set, enforces the use of session cookies for all users which expire when the browser is closed.
diff --git a/docs/usage-and-performance-tools/usage-analytics-reference.md b/docs/usage-and-performance-tools/usage-analytics-reference.md
index 5bf59a28de0..dd4949f9893 100644
--- a/docs/usage-and-performance-tools/usage-analytics-reference.md
+++ b/docs/usage-and-performance-tools/usage-analytics-reference.md
@@ -676,6 +676,7 @@ The Query Source column on the [Query log](#query-log) model takes one of:
- embedded-json-download
- embedded-question
- embedded-xlsx-download
+- exploration
- json-download
- map-tiles
- metric