The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Auto-update documentation for master (#74874)
github-automation-metabaseaabdd5ceb7d1
diff --git a/docs/api.json b/docs/api.jsonindex 8eb0f600792..acfa52f7be1 100644--- a/docs/api.json+++ b/docs/api.json@@ -3466,6 +3466,11 @@"required" : [ "unknown" ]} ]},+ "metabase.agent-api.api.card-display" : {+ "description" : "Display types accepted by Card. Validates LLM-passed values so a bogus\n value (e.g. `\"potato\"`) gets a 400 rather than persisting junk.",+ "type" : "string",+ "enum" : [ "table", "bar", "line", "pie", "scatter", "area", "row", "combo", "pivot", "scalar", "smartscalar", "gauge", "progress", "funnel", "map", "waterfall", "sankey" ]+ },"metabase.agent-api.api.column-metadata" : {"description" : "Metadata for a single result column.","type" : "object",@@ -3529,6 +3534,69 @@},"required" : [ "query" ]},+ "metabase.agent-api.api.create-collection-request" : {+ "description" : "Request shape for `create_collection`. `:parent_collection_id` is named separately from\n the internal `:parent_id` field to make the LLM-facing API less ambiguous (the caller is\n saying \"put it under this parent\", not echoing back a server-set field).",+ "type" : "object",+ "properties" : {+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ },+ "parent_collection_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "name" ]+ },+ "metabase.agent-api.api.create-collection-response" : {+ "description" : "Returned by `create_collection`. Exposes the materialized-path `:location` so callers\n can sanity-check nesting without a follow-up read.",+ "type" : "object",+ "properties" : {+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "location" : {+ "type" : "string",+ "minLength" : 1+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ },+ "parent_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "name", "parent_id", "location", "description" ]+ },"metabase.agent-api.api.create-dashboard-request" : {"type" : "object","properties" : {@@ -3627,7 +3695,7 @@},"display" : {"oneOf" : [ {- "type" : "string"+ "$ref" : "#/components/schemas/metabase.agent-api.api.card-display"}, {"type" : "null"} ]@@ -3685,10 +3753,60 @@},"required" : [ "id", "name", "display", "collection_id", "description" ]},- "metabase.agent-api.api.entity-type" : {- "description" : "The type of queryable entity.",- "type" : "string",- "enum" : [ "table", "metric" ]+ "metabase.agent-api.api.dashcard-mutation" : {+ "description" : "One dashcard mutation. Discriminated on `:action`:\n - `add` : requires `card_id`. Auto-positioned. Optional `display_size`(\"wide\", \"tall\", or \"full\").\n - `remove` : requires `dashcard_id`.\n - `move` : requires `dashcard_id` and `position` (\"top\" or \"bottom\").",+ "oneOf" : [ {+ "type" : "object",+ "properties" : {+ "action" : {+ "const" : "add"+ },+ "card_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "display_size" : {+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "wide", "tall", "full" ]+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "action", "card_id" ]+ }, {+ "type" : "object",+ "properties" : {+ "action" : {+ "const" : "remove"+ },+ "dashcard_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "action", "dashcard_id" ]+ }, {+ "type" : "object",+ "properties" : {+ "action" : {+ "const" : "move"+ },+ "dashcard_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "position" : {+ "type" : "string",+ "enum" : [ "top", "bottom" ]+ }+ },+ "required" : [ "action", "dashcard_id", "position" ]+ } ]},"metabase.agent-api.api.execute-query-request" : {"description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",@@ -3740,233 +3858,21 @@},"required" : [ "status" ]},- "metabase.agent-api.api.field" : {- "description" : "A field from a table or metric. field_id is the real database field ID (integer) for concrete fields,\n or a string alias for expression/aggregation columns.",- "type" : "object",- "properties" : {- "base_type" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "coercion_strategy" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "name" : {- "type" : "string"- },- "semantic_type" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "display_name" : {- "type" : "string"- },- "field_values" : {- "oneOf" : [ {- "type" : "array",- "items" : { }- }, {- "type" : "null"- } ]- },- "type" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-type"- }, {- "type" : "null"- } ]- },- "field_id" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"- },- "effective_type" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "database_type" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- }- },- "required" : [ "field_id", "name", "display_name" ]- },- "metabase.agent-api.api.field-id" : {- "description" : "Field id as accepted by agent_api endpoints — either a real app-DB field id (positive integer)\n or a string alias for expression/aggregation columns.",- "anyOf" : [ {- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"- }, {- "type" : "string"- } ]- },- "metabase.agent-api.api.field-type" : {- "description" : "A data type for a field derived from Metabase's type hierarchy.",- "type" : "string",- "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]- },- "metabase.agent-api.api.field-values" : {- "description" : "Statistics and sample values for a specific field.",- "type" : "object",- "properties" : {- "field_id" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"- }, {- "type" : "null"- } ]- },- "statistics" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.agent-api.api.statistics"- }, {- "type" : "null"- } ]- },- "values" : {- "oneOf" : [ {- "type" : "array",- "items" : { }- }, {- "type" : "null"- } ]- }- }- },- "metabase.agent-api.api.measure" : {- "description" : "A reusable aggregation expression associated with a table. Reference via measure_id in the aggregations array.",+ "metabase.agent-api.api.execute-sql-request" : {+ "description" : "Request shape for /v1/execute-sql. The LLM passes a raw SQL string against a target database.","type" : "object","properties" : {- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "display_name" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"- }- },- "required" : [ "id", "name" ]- },- "metabase.agent-api.api.metric" : {- "description" : "A metric with its queryable dimensions and segments. The default_time_dimension_field_id is the field_id of the recommended time dimension for temporal breakouts.",- "type" : "object",- "properties" : {- "default_time_dimension_field_id" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"- }, {- "type" : "null"- } ]- },- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"- },- "queryable_dimensions" : {- "oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field"- }- }, {- "type" : "null"- } ]- },- "segments" : {- "oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.segment"- }- }, {- "type" : "null"- } ]- },- "type" : {- "const" : "metric"- },- "verified" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- },- "required" : [ "id", "type", "name" ]- },- "metabase.agent-api.api.metric-summary" : {- "description" : "Summary of a metric associated with a table. Includes the field_id of the default time dimension for temporal breakouts.",- "type" : "object",- "properties" : {- "default_time_dimension_field_id" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"- }, {- "type" : "null"- } ]- },- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"+ "database_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1},- "type" : {- "const" : "metric"+ "sql" : {+ "type" : "string",+ "minLength" : 1}},- "required" : [ "id", "type", "name" ]+ "required" : [ "database_id", "sql" ]},"metabase.agent-api.api.query-request" : {"description" : "Request body for /v2/query. Accepts either a fresh-query payload (`{:query <external-query>}`,\n same shape as /v2/construct-query) or a `:continuation_token` from a prior response.\n\n Both branches are closed maps: extra top-level keys (e.g. the legacy\n `source_entity` / `referenced_entities` envelope, or sending `:query` and\n `:continuation_token` simultaneously) are rejected with a 400.",@@ -4030,73 +3936,58 @@},"required" : [ "status" ]},- "metabase.agent-api.api.related-table" : {- "description" : "A table related to the queried entity via foreign key. The related_by field indicates the FK field name.",+ "metabase.agent-api.api.read-resource-item" : {+ "description" : "One fetched resource. Either `:content` (success) or `:error` (failure) is present.","type" : "object","properties" : {- "database_engine" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"- },- "database_id" : {- "oneOf" : [ {- "type" : "integer"- }, {- "type" : "null"- } ]- },- "related_by" : {- "oneOf" : [ {- "type" : "string"- }, {+ "content" : {+ "oneOf" : [ { }, {"type" : "null"} ]},- "display_name" : {+ "error" : {"oneOf" : [ {"type" : "string"}, {"type" : "null"} ]},- "type" : {- "const" : "table"- },- "fields" : {- "oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field"- }- }, {- "type" : "null"- } ]- },- "database_schema" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]+ "uri" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "uri" ]+ },+ "metabase.agent-api.api.read-resource-request" : {+ "description" : "Request shape for /v1/read-resource. Accepts up to 5 metabase:// URIs.",+ "type" : "object",+ "properties" : {+ "uris" : {+ "type" : "array",+ "items" : {+ "type" : "string",+ "minLength" : 1+ }+ }+ },+ "required" : [ "uris" ]+ },+ "metabase.agent-api.api.read-resource-response" : {+ "description" : "Response shape from /v1/read-resource. `:resources` is the per-URI result list;\n `:output` is the formatted XML string the LLM consumes.",+ "type" : "object",+ "properties" : {+ "output" : {+ "type" : "string"},- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]+ "resources" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.read-resource-item"+ }}},- "required" : [ "id", "type", "name" ]+ "required" : [ "resources", "output" ]},"metabase.agent-api.api.search-response" : {"description" : "Search results containing tables and metrics matching the query.",@@ -4176,215 +4067,168 @@},"required" : [ "id", "type", "name" ]},- "metabase.agent-api.api.segment" : {- "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",+ "metabase.agent-api.api.update-dashboard-request" : {+ "description" : "Patch shape for `update_dashboard`. Metadata fields and an optional `dashcards` list of\n add/remove/move mutations applied in order.","type" : "object",- "properties" : {- "description" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "display_name" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"- }- },- "required" : [ "id", "name" ]- },- "metabase.agent-api.api.statistics" : {- "description" : "Statistical summary of a field's values computed during database sync. Includes counts, percentages, numeric summaries (min/max/avg/quartiles/sd), and date ranges.",- "type" : "object",- "properties" : {- "min" : {- "oneOf" : [ {- "type" : "number"- }, {- "type" : "null"- } ]- },- "percent_url" : {- "oneOf" : [ {- "type" : "number"- }, {- "type" : "null"- } ]- },- "average_length" : {- "oneOf" : [ {- "type" : "number"- }, {- "type" : "null"- } ]- },- "earliest" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "q1" : {+ "properties" : {+ "archived" : {"oneOf" : [ {- "type" : "number"+ "type" : "boolean"}, {"type" : "null"} ]},- "max" : {+ "collection_id" : {"oneOf" : [ {- "type" : "number"+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}, {"type" : "null"} ]},- "distinct_count" : {+ "dashcards" : {"oneOf" : [ {- "type" : "integer"+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.dashcard-mutation"+ }}, {"type" : "null"} ]},- "percent_state" : {+ "description" : {"oneOf" : [ {- "type" : "number"+ "type" : "string"}, {"type" : "null"} ]},- "percent_null" : {+ "name" : {"oneOf" : [ {- "type" : "number"+ "type" : "string",+ "minLength" : 1}, {"type" : "null"} ]+ }+ }+ },+ "metabase.agent-api.api.update-dashboard-response" : {+ "description" : "Returned by `update_dashboard`. `:dashcard_ids` is the post-mutation list of dashcard\n ids in row/col order so the LLM can confirm what landed on the dashboard.",+ "type" : "object",+ "properties" : {+ "archived" : {+ "type" : "boolean"},- "avg" : {+ "collection_id" : {"oneOf" : [ {- "type" : "number"+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}, {"type" : "null"} ]},- "sd" : {- "oneOf" : [ {- "type" : "number"- }, {- "type" : "null"- } ]+ "dashcard_ids" : {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }},- "percent_email" : {+ "description" : {"oneOf" : [ {- "type" : "number"+ "type" : "string"}, {"type" : "null"} ]},- "latest" : {+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "name" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id", "name", "collection_id", "description", "archived", "dashcard_ids" ]+ },+ "metabase.agent-api.api.update-question-request" : {+ "description" : "Patch shape for `update_question`. Every field is optional; only the fields the caller\n passes are changed. `:query` accepts a base64-encoded MBQL string (or query_handle UUID\n resolved upstream in the MCP layer).",+ "type" : "object",+ "properties" : {+ "archived" : {"oneOf" : [ {- "type" : "string"+ "type" : "boolean"}, {"type" : "null"} ]},- "q3" : {+ "collection_id" : {"oneOf" : [ {- "type" : "number"+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}, {"type" : "null"} ]},- "percent_json" : {+ "description" : {"oneOf" : [ {- "type" : "number"+ "type" : "string"}, {"type" : "null"} ]- }- }- },- "metabase.agent-api.api.table" : {- "description" : "Full details of a table including its fields, related tables, metrics, and segments.",- "type" : "object",- "properties" : {- "database_engine" : {- "type" : "string"- },- "id" : {- "type" : "integer"- },- "name" : {- "type" : "string"- },- "database_id" : {- "type" : "integer"},- "related_tables" : {+ "display" : {"oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.related-table"- }+ "$ref" : "#/components/schemas/metabase.agent-api.api.card-display"}, {"type" : "null"} ]},- "display_name" : {- "type" : "string"- },- "segments" : {+ "name" : {"oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.segment"- }+ "type" : "string",+ "minLength" : 1}, {"type" : "null"} ]},- "type" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.entity-type"- },- "fields" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field"- }- },- "database_schema" : {+ "query" : {"oneOf" : [ {- "type" : "string"+ "type" : "string",+ "minLength" : 1}, {"type" : "null"} ]},- "metrics" : {+ "visualization_settings" : {"oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.metric-summary"- }+ "type" : "object",+ "properties" : { }}, {"type" : "null"} ]+ }+ }+ },+ "metabase.agent-api.api.update-question-response" : {+ "description" : "Returned by `update_question` - the fields the LLM is most likely to want to read back\n after an update. Excludes the full dataset_query, which the caller can re-fetch via\n `read_resource` if needed.",+ "type" : "object",+ "properties" : {+ "archived" : {+ "type" : "boolean"},- "measures" : {+ "collection_id" : {"oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.measure"- }+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}, {"type" : "null"} ]@@ -4395,9 +4239,21 @@}, {"type" : "null"} ]+ },+ "display" : {+ "type" : "string"+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "name" : {+ "type" : "string",+ "minLength" : 1}},- "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]+ "required" : [ "id", "name", "display", "collection_id", "description", "archived" ]},"metabase.analyze.query-results.ResultsMetadata" : {"description" : "value must be an array of valid results column metadata maps.",@@ -14615,11 +14471,11 @@"tags" : [ "/api/activity" ]}},- "/api/agent/v1/dashboard" : {+ "/api/agent/v1/collection" : {"post" : {- "operationId" : "post-api-agent-v1-dashboard",- "summary" : "POST /api/agent/v1/dashboard",- "description" : "Create a new dashboard, optionally populated with saved questions.\n\n Pass `question_ids` to add existing saved questions as cards on the dashboard.\n Cards are automatically positioned on the grid based on their display type.",+ "operationId" : "post-api-agent-v1-collection",+ "summary" : "POST /api/agent/v1/collection",+ "description" : "Create a new Collection.\n\n Pass `parent_collection_id` to nest under another collection; omit for a root-level collection.\n The caller must have write access to the parent (or root, if no parent given).","parameters" : [ ],"responses" : {"2XX" : {@@ -14627,7 +14483,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.create-dashboard-response"+ "$ref" : "#/components/schemas/metabase.agent-api.api.create-collection-response"}}}@@ -14643,7 +14499,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.create-dashboard-request"+ "$ref" : "#/components/schemas/metabase.agent-api.api.create-collection-request"}}}@@ -14651,11 +14507,11 @@"tags" : [ "/api/agent" ]}},- "/api/agent/v1/execute" : {+ "/api/agent/v1/dashboard" : {"post" : {- "operationId" : "post-api-agent-v1-execute",- "summary" : "POST /api/agent/v1/execute",- "description" : "Execute an MBQL query and return results.\n\n Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it,\n returning results with column metadata.\n\n Response format:\n - On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}\n - On failure: {:status :failed :error \"message\" ...}\n\n Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).",+ "operationId" : "post-api-agent-v1-dashboard",+ "summary" : "POST /api/agent/v1/dashboard",+ "description" : "Create a new dashboard, optionally populated with saved questions.\n\n Pass `question_ids` to add existing saved questions as cards on the dashboard.\n Cards are automatically positioned on the grid based on their display type.","parameters" : [ ],"responses" : {"2XX" : {@@ -14663,7 +14519,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-response"+ "$ref" : "#/components/schemas/metabase.agent-api.api.create-dashboard-response"}}}@@ -14679,7 +14535,7 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-request"+ "$ref" : "#/components/schemas/metabase.agent-api.api.create-dashboard-request"}}}@@ -14687,11 +14543,11 @@"tags" : [ "/api/agent" ]}},- "/api/agent/v1/metric/{id}" : {- "get" : {- "operationId" : "get-api-agent-v1-metric-id",- "summary" : "GET /api/agent/v1/metric/{id}",- "description" : "Get details for a metric by ID.",+ "/api/agent/v1/dashboard/{id}" : {+ "put" : {+ "operationId" : "put-api-agent-v1-dashboard-id",+ "summary" : "PUT /api/agent/v1/dashboard/{id}",+ "description" : "Update a dashboard. Patch semantics - only fields you pass are changed.\n\n Metadata: `name`, `description`, `collection_id`, `archived`. Dashcard mutations\n are submitted under `dashcards` as a list of `{action: add|remove|move, ...}`\n entries applied in order. `add` requires `card_id`; `remove` and `move` require\n `dashcard_id`.","parameters" : [ {"in" : "path","name" : "id",@@ -14701,102 +14557,86 @@"minimum" : 1},"description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "with-default-temporal-breakout",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-field-values",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-queryable-dimensions",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.update-dashboard-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"}- }, {- "in" : "query",- "name" : "with-segments",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.update-dashboard-request"+ }+ }}- } ],+ },+ "tags" : [ "/api/agent" ]+ }+ },+ "/api/agent/v1/execute" : {+ "post" : {+ "operationId" : "post-api-agent-v1-execute",+ "summary" : "POST /api/agent/v1/execute",+ "description" : "Execute an MBQL query and return results.\n\n Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it,\n returning results with column metadata.\n\n Response format:\n - On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}\n - On failure: {:status :failed :error \"message\" ...}\n\n Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response","content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.metric"+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-response"}}}- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-request"+ }+ }}},"tags" : [ "/api/agent" ]}},- "/api/agent/v1/metric/{id}/field/{field-id}/values" : {- "get" : {- "operationId" : "get-api-agent-v1-metric-id-field-field-id-values",- "summary" : "GET /api/agent/v1/metric/{id}/field/{field-id}/values",- "description" : "Get statistics and sample values for a metric field.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "path",- "name" : "field-id",- "required" : true,- "schema" : {- "type" : "string",- "minLength" : 1- }- } ],+ "/api/agent/v1/execute-sql" : {+ "post" : {+ "operationId" : "post-api-agent-v1-execute-sql",+ "summary" : "POST /api/agent/v1/execute-sql",+ "description" : "Execute a raw SQL query against a database. Returns rows + column metadata.\n\n Requires the user to have native-query permission on the target database; the QP\n middleware enforces this. The instance-level `mcp-execute-sql-enabled` setting\n must also be on (it is by default).",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response","content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-values"+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-response"}}}@@ -14808,6 +14648,15 @@"description" : "Server error response"}},+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-sql-request"+ }+ }+ }+ },"tags" : [ "/api/agent" ]}},@@ -14848,7 +14697,7 @@"post" : {"operationId" : "post-api-agent-v1-question","summary" : "POST /api/agent/v1/question",- "description" : "Save a previously constructed query as a named question (card).\n\n The `query` parameter should be a base64-encoded string returned by construct_query.\n Optionally specify display type, description, collection, and visualization settings.",+ "description" : "Save a previously constructed query as a named question (card).\n\n The `query` parameter accepts a `query_handle` (UUID) returned by `construct_query`,\n or a base64-encoded MBQL string. MCP callers should always use the handle.\n Optionally specify display type, description, collection, and visualization settings.","parameters" : [ ],"responses" : {"2XX" : {@@ -14880,6 +14729,87 @@"tags" : [ "/api/agent" ]}},+ "/api/agent/v1/question/{id}" : {+ "put" : {+ "operationId" : "put-api-agent-v1-question-id",+ "summary" : "PUT /api/agent/v1/question/{id}",+ "description" : "Update a saved question (card). Patch semantics - only fields that you pass are changed.\n\n Set `collection_id` to move the card to a different collection. Set `archived: true` to archive.\n Pass `query` (a query_handle from construct_query, or a base64 MBQL string) to replace the underlying query.",+ "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.agent-api.api.update-question-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.update-question-request"+ }+ }+ }+ },+ "tags" : [ "/api/agent" ]+ }+ },+ "/api/agent/v1/read-resource" : {+ "post" : {+ "operationId" : "post-api-agent-v1-read-resource",+ "summary" : "POST /api/agent/v1/read-resource",+ "description" : "Read one or more Metabase resources via metabase:// URI patterns.\n\n Dispatches into the shared URI resolver in `metabase.metabot.tools.resources`,\n which validates URIs, fetches entities with per-URI permission checks, and\n returns a map of `{:resources ... :output ...}`. Up to 5 URIs per call.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.read-resource-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.agent-api.api.read-resource-request"+ }+ }+ }+ },+ "tags" : [ "/api/agent" ]+ }+ },"/api/agent/v1/search" : {"post" : {"operationId" : "post-api-agent-v1-search",@@ -14950,152 +14880,6 @@"tags" : [ "/api/agent" ]}},- "/api/agent/v1/table/{id}" : {- "get" : {- "operationId" : "get-api-agent-v1-table-id",- "summary" : "GET /api/agent/v1/table/{id}",- "description" : "Get details for a table by ID.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "with-field-values",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-fields",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-related-tables",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-metrics",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-measures",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "with-segments",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.table"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/agent" ]- }- },- "/api/agent/v1/table/{id}/field/{field-id}/values" : {- "get" : {- "operationId" : "get-api-agent-v1-table-id-field-field-id-values",- "summary" : "GET /api/agent/v1/table/{id}/field/{field-id}/values",- "description" : "Get statistics and sample values for a table field.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "path",- "name" : "field-id",- "required" : true,- "schema" : {- "type" : "string",- "minLength" : 1- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase.agent-api.api.field-values"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/agent" ]- }- },"/api/agent/v2/construct-query" : {"post" : {"operationId" : "post-api-agent-v2-construct-query",@@ -25348,6 +25132,31 @@"tags" : [ "/api/ee/custom-viz-plugin" ]}},+ "/api/ee/custom-viz-plugin/sandbox-host" : {+ "get" : {+ "operationId" : "get-api-ee-custom-viz-plugin-sandbox-host",+ "summary" : "GET /api/ee/custom-viz-plugin/sandbox-host",+ "description" : "Serve a minimal HTML document used as the iframe `src` for the near-membrane custom-viz\n sandbox. The response carries a per-document `Content-Security-Policy` that permits\n `'unsafe-eval'` only inside this iframe, so the main Metabase document keeps its strict\n nonce-based CSP.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : { }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/ee/custom-viz-plugin" ]+ }+ },"/api/ee/custom-viz-plugin/{id}" : {"delete" : {"operationId" : "delete-api-ee-custom-viz-plugin-id",diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.mdindex 533288e65c8..b0911e2fd58 100644--- a/docs/configuring-metabase/environment-variables.md+++ b/docs/configuring-metabase/environment-variables.md@@ -1030,7 +1030,7 @@ When set to `true`, users who log in via JWT will automatically get a Metabase a- [Exported as](../installation-and-operation/serialization.md): `landing-page`.- [Configuration file name](./config-file.md): `landing-page`-Enter a URL of the landing page to show the user. This overrides the custom homepage setting above.+Enter a relative URL like /dashboard/1 or /collection/2.### `MB_LANDING_PAGE_ILLUSTRATION`