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 (#76303)
github-automation-metabasedaa7c3d33ca4
diff --git a/docs/api.json b/docs/api.jsonindex aeb2aa682bc..9cc04ef520f 100644--- a/docs/api.json+++ b/docs/api.json@@ -14740,7 +14740,7 @@"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.\n If `collection_id` is omitted the dashboard is saved to the caller's personal collection.\n The response `collection_path` is the saved location.",+ "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.\n If `collection_id` is omitted the dashboard is saved to the caller's personal collection.\n Pass an explicit `null` to save it to the root collection.\n The response `collection_path` is the saved location.","parameters" : [ ],"responses" : {"2XX" : {@@ -14926,7 +14926,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 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.\n If `collection_id` is omitted the question is saved to the caller's personal collection.\n The response `collection_path` is the saved location.",+ "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.\n If `collection_id` is omitted the question is saved to the caller's personal collection.\n Pass an explicit `null` to save it to the root collection.\n The response `collection_path` is the saved location.","parameters" : [ ],"responses" : {"2XX" : {@@ -19513,27 +19513,76 @@"tags" : [ "/api/comment" ]}},- "/api/dashboard" : {+ "/api/curated-search" : {"get" : {- "operationId" : "get-api-dashboard",- "summary" : "GET /api/dashboard",- "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)",- "parameters" : [ {- "in" : "query",- "name" : "f",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "string",- "enum" : [ "all", "mine", "archived" ]- }, {- "type" : "null"- } ]- }- } ],+ "operationId" : "get-api-curated-search",+ "summary" : "GET /api/curated-search",+ "description" : "Get all curated search entries, paginated.",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "data" : {+ "type" : "array",+ "items" : {+ "type" : "object",+ "properties" : {+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "integer"+ },+ "model" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "model", "id" ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "search_prompt" : {+ "type" : "string"+ },+ "usage_instructions" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "verified" : {+ "type" : "boolean"+ }+ },+ "required" : [ "id", "search_prompt", "entity", "verified" ]+ }+ },+ "limit" : {+ "type" : "integer"+ },+ "offset" : {+ "type" : "integer"+ },+ "total" : {+ "type" : "integer"+ }+ },+ "required" : [ "data", "total", "limit", "offset" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -19542,17 +19591,59 @@"description" : "Server error response"}},- "deprecated" : true,- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/curated-search" ]},"post" : {- "operationId" : "post-api-dashboard",- "summary" : "POST /api/dashboard",- "description" : "Create a new Dashboard.",+ "operationId" : "post-api-curated-search",+ "summary" : "POST /api/curated-search",+ "description" : "Create a new curated search entry.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "integer"+ },+ "model" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "model", "id" ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "search_prompt" : {+ "type" : "string"+ },+ "usage_instructions" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "verified" : {+ "type" : "boolean"+ }+ },+ "required" : [ "id", "search_prompt", "entity", "verified" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -19567,69 +19658,112 @@"schema" : {"type" : "object","properties" : {- "cache_ttl" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- },- "collection_id" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "model" : {+ "type" : "string",+ "enum" : [ "table", "card", "model", "metric", "question" ]+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "model", "id" ]},- "collection_position" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]+ "search_prompt" : {+ "type" : "string",+ "minLength" : 1},- "description" : {+ "usage_instructions" : {"oneOf" : [ {"type" : "string"}, {"type" : "null"} ]},- "name" : {- "type" : "string",- "minLength" : 1- },- "parameters" : {+ "verified" : {"oneOf" : [ {- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"+ "type" : "boolean"}, {"type" : "null"} ]}},- "required" : [ "name" ]+ "required" : [ "search_prompt", "entity" ]}}}},- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/curated-search" ]}},- "/api/dashboard/embeddable" : {+ "/api/curated-search/{id}" : {"get" : {- "operationId" : "get-api-dashboard-embeddable",- "summary" : "GET /api/dashboard/embeddable",- "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.",- "parameters" : [ ],+ "operationId" : "get-api-curated-search-id",+ "summary" : "GET /api/curated-search/{id}",+ "description" : "Get a curated search entry by ID.",+ "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"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "integer"+ },+ "model" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "model", "id" ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "search_prompt" : {+ "type" : "string"+ },+ "usage_instructions" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "verified" : {+ "type" : "boolean"+ }+ },+ "required" : [ "id", "search_prompt", "entity", "verified" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -19638,79 +19772,15 @@"description" : "Server error response"}},- "tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/params/valid-filter-fields" : {- "get" : {- "operationId" : "get-api-dashboard-params-valid-filter-fields",- "summary" : "GET /api/dashboard/params/valid-filter-fields",- "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query",+ "tags" : [ "/api/curated-search" ]+ },+ "put" : {+ "operationId" : "put-api-curated-search-id",+ "summary" : "PUT /api/curated-search/{id}",+ "description" : "Update a curated search entry by ID. Only the provided fields are changed; sending a null\n usage_instructions clears it.","parameters" : [ {- "in" : "query",- "name" : "filtered",- "required" : true,- "schema" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"- }- }- }, {- "in" : "query",- "name" : "filtering",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"- }- }, {- "type" : "null"- } ]- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {- "post" : {- "operationId" : "post-api-dashboard-pivot-dashboard-id-dashcard-dashcard-id-card-card-id-query",- "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",- "description" : "Run a pivot table query for a specific DashCard.",- "parameters" : [ {- "in" : "path",- "name" : "dashboard-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "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",+ "in" : "path",+ "name" : "id","required" : true,"schema" : {"type" : "integer",@@ -19720,7 +19790,50 @@} ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "integer"+ },+ "model" : {+ "type" : "string"+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "model", "id" ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "search_prompt" : {+ "type" : "string"+ },+ "usage_instructions" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "verified" : {+ "type" : "boolean"+ }+ },+ "required" : [ "id", "search_prompt", "entity", "verified" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -19735,63 +19848,59 @@"schema" : {"type" : "object","properties" : {- "parameters" : {- "oneOf" : [ {- "type" : "array",- "items" : {- "description" : "value must be a parameter map with an 'id' key",- "allOf" : [ {- "type" : "object",- "properties" : {- "id" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "id" ]- }, {- "type" : "object",- "additionalProperties" : { }- } ]+ "entity" : {+ "type" : "object",+ "properties" : {+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "model" : {+ "type" : "string",+ "enum" : [ "table", "card", "model", "metric", "question" ]+ },+ "name" : {+ "type" : "string"}+ },+ "required" : [ "model", "id" ]+ },+ "search_prompt" : {+ "type" : "string",+ "minLength" : 1+ },+ "usage_instructions" : {+ "oneOf" : [ {+ "type" : "string"}, {"type" : "null"} ]+ },+ "verified" : {+ "type" : "boolean"}}}}}},- "tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/public" : {- "get" : {- "operationId" : "get-api-dashboard-public",- "summary" : "GET /api/dashboard/public",- "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"+ "tags" : [ "/api/curated-search" ]+ },+ "delete" : {+ "operationId" : "delete-api-curated-search-id",+ "summary" : "DELETE /api/curated-search/{id}",+ "description" : "Delete a curated search entry by ID.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1},- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/save" : {- "post" : {- "operationId" : "post-api-dashboard-save",- "summary" : "POST /api/dashboard/save",- "description" : "Save a denormalized description of dashboard.",- "parameters" : [ ],+ "description" : "value must be an integer greater than zero."+ } ],"responses" : {"2XX" : {"description" : "Successful response"@@ -19803,23 +19912,26 @@"description" : "Server error response"}},- "tags" : [ "/api/dashboard" ]+ "tags" : [ "/api/curated-search" ]}},- "/api/dashboard/save/collection/{parent-collection-id}" : {- "post" : {- "operationId" : "post-api-dashboard-save-collection-parent-collection-id",- "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",- "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",+ "/api/dashboard" : {+ "get" : {+ "operationId" : "get-api-dashboard",+ "summary" : "GET /api/dashboard",+ "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)","parameters" : [ {- "in" : "path",- "name" : "parent-collection-id",- "required" : true,+ "in" : "query",+ "name" : "f",+ "required" : false,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "all", "mine", "archived" ]+ }, {+ "type" : "null"+ } ]+ }} ],"responses" : {"2XX" : {@@ -19832,42 +19944,14 @@"description" : "Server error response"}},+ "deprecated" : true,"tags" : [ "/api/dashboard" ]- }- },- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {+ },"post" : {- "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query",- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.",- "parameters" : [ {- "in" : "path",- "name" : "dashboard-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "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."- } ],+ "operationId" : "post-api-dashboard",+ "summary" : "POST /api/dashboard",+ "description" : "Create a new Dashboard.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -19885,38 +19969,53 @@"schema" : {"type" : "object","properties" : {- "dashboard_load_id" : {+ "cache_ttl" : {"oneOf" : [ {- "type" : "string",- "minLength" : 1+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}, {"type" : "null"} ]},- "parameters" : {+ "collection_id" : {"oneOf" : [ {- "type" : "array",- "items" : {- "description" : "value must be a parameter map with an 'id' key",- "allOf" : [ {- "type" : "object",- "properties" : {- "id" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "id" ]- }, {- "type" : "object",- "additionalProperties" : { }- } ]- }+ "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+ },+ "parameters" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"}, {"type" : "null"} ]}- }+ },+ "required" : [ "name" ]}}}@@ -19924,11 +20023,75 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {+ "/api/dashboard/embeddable" : {+ "get" : {+ "operationId" : "get-api-dashboard-embeddable",+ "summary" : "GET /api/dashboard/embeddable",+ "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/params/valid-filter-fields" : {+ "get" : {+ "operationId" : "get-api-dashboard-params-valid-filter-fields",+ "summary" : "GET /api/dashboard/params/valid-filter-fields",+ "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query",+ "parameters" : [ {+ "in" : "query",+ "name" : "filtered",+ "required" : true,+ "schema" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"+ }+ }+ }, {+ "in" : "query",+ "name" : "filtering",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"+ }+ }, {+ "type" : "null"+ } ]+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {"post" : {- "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query-export-format",- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",+ "operationId" : "post-api-dashboard-pivot-dashboard-id-dashcard-dashcard-id-card-card-id-query",+ "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",+ "description" : "Run a pivot table query for a specific DashCard.","parameters" : [ {"in" : "path","name" : "dashboard-id",@@ -19956,13 +20119,6 @@"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"- }} ],"responses" : {"2XX" : {@@ -19981,44 +20137,30 @@"schema" : {"type" : "object","properties" : {- "format_rows" : {- "default" : false,- "type" : "boolean"- },"parameters" : {"oneOf" : [ {- "anyOf" : [ {- "type" : "array",- "items" : {- "description" : "value must be a parameter map with an 'id' key",- "allOf" : [ {- "type" : "object",- "properties" : {- "id" : {- "type" : "string",- "minLength" : 1- }- },- "required" : [ "id" ]- }, {- "type" : "object",- "additionalProperties" : { }- } ]- }- }, {- "description" : "value must be a valid JSON string.",- "type" : "string"- } ]+ "type" : "array",+ "items" : {+ "description" : "value must be a parameter map with an 'id' key",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id" ]+ }, {+ "type" : "object",+ "additionalProperties" : { }+ } ]+ }}, {"type" : "null"} ]- },- "pivot_results" : {- "default" : false,- "type" : "boolean"}- },- "required" : [ ]+ }}}}@@ -20026,37 +20168,60 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute" : {+ "/api/dashboard/public" : {"get" : {- "operationId" : "get-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",- "summary" : "GET /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",- "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",- "parameters" : [ {- "in" : "path",- "name" : "dashboard-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1+ "operationId" : "get-api-dashboard-public",+ "summary" : "GET /api/dashboard/public",+ "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"},- "description" : "value must be an integer greater than zero."- }, {+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/save" : {+ "post" : {+ "operationId" : "post-api-dashboard-save",+ "summary" : "POST /api/dashboard/save",+ "description" : "Save a denormalized description of dashboard.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/save/collection/{parent-collection-id}" : {+ "post" : {+ "operationId" : "post-api-dashboard-save-collection-parent-collection-id",+ "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",+ "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",+ "parameters" : [ {"in" : "path",- "name" : "dashcard-id",+ "name" : "parent-collection-id","required" : true,"schema" : {"type" : "integer","minimum" : 1},"description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "parameters",- "required" : false,- "schema" : {- "type" : "string"- },- "description" : "value must be a valid JSON string."} ],"responses" : {"2XX" : {@@ -20070,11 +20235,13 @@}},"tags" : [ "/api/dashboard" ]- },+ }+ },+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {"post" : {- "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",- "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.\n `extra_parameters` should be the extra, user entered parameter values.",+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query",+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.","parameters" : [ {"in" : "path","name" : "dashboard-id",@@ -20093,6 +20260,15 @@"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."} ],"responses" : {"2XX" : {@@ -20111,15 +20287,241 @@"schema" : {"type" : "object","properties" : {- "parameters" : {+ "dashboard_load_id" : {"oneOf" : [ {- "type" : "object",- "additionalProperties" : { }+ "type" : "string",+ "minLength" : 1}, {"type" : "null"} ]- }- }+ },+ "parameters" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be a parameter map with an 'id' key",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id" ]+ }, {+ "type" : "object",+ "additionalProperties" : { }+ } ]+ }+ }, {+ "type" : "null"+ } ]+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {+ "post" : {+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query-export-format",+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",+ "parameters" : [ {+ "in" : "path",+ "name" : "dashboard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "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"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "format_rows" : {+ "default" : false,+ "type" : "boolean"+ },+ "parameters" : {+ "oneOf" : [ {+ "anyOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be a parameter map with an 'id' key",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id" ]+ }, {+ "type" : "object",+ "additionalProperties" : { }+ } ]+ }+ }, {+ "description" : "value must be a valid JSON string.",+ "type" : "string"+ } ]+ }, {+ "type" : "null"+ } ]+ },+ "pivot_results" : {+ "default" : false,+ "type" : "boolean"+ }+ },+ "required" : [ ]+ }+ }+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute" : {+ "get" : {+ "operationId" : "get-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",+ "summary" : "GET /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",+ "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",+ "parameters" : [ {+ "in" : "path",+ "name" : "dashboard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "path",+ "name" : "dashcard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "parameters",+ "required" : false,+ "schema" : {+ "type" : "string"+ },+ "description" : "value must be a valid JSON string."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]+ },+ "post" : {+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",+ "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.\n `extra_parameters` should be the extra, user entered parameter values.",+ "parameters" : [ {+ "in" : "path",+ "name" : "dashboard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "path",+ "name" : "dashcard-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "parameters" : {+ "oneOf" : [ {+ "type" : "object",+ "additionalProperties" : { }+ }, {+ "type" : "null"+ } ]+ }+ }}}}@@ -20851,30 +21253,29 @@"tags" : [ "/api/dashboard" ]}},- "/api/dashboard/{id}/query_metadata" : {- "get" : {- "operationId" : "get-api-dashboard-id-query_metadata",- "summary" : "GET /api/dashboard/{id}/query_metadata",- "description" : "Get all of the required query metadata for the cards on dashboard.",+ "/api/dashboard/{id}/pdf" : {+ "post" : {+ "operationId" : "post-api-dashboard-id-pdf",+ "summary" : "POST /api/dashboard/{id}/pdf",+ "description" : "Render Dashboard with ID to a PDF (server-side, the same way dashboard subscriptions render charts) and stream it\n back as a file download.\n\n `parameters` are runtime parameter overrides -- the same shape the dashcard query endpoints accept: a sequence of\n `{:id ... :value ...}` maps, or a JSON-encoded string of that sequence (the string form lets an HTML `<form>`\n action drive the download). Parameters left unspecified fall back to the dashboard's own defaults.\n\n `paper_size` is `\"a4\"` (default) or `\"letter\"`.","parameters" : [ {"in" : "path","name" : "id","required" : true,"schema" : {- "anyOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "description" : "String must be a valid 21-character NanoID string.",- "type" : "string",- "pattern" : "^[A-Za-z0-9_\\-]{21}$"- } ]- }+ "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" : { }+ }+ }},"4XX" : {"description" : "Client error response"@@ -20883,7 +21284,91 @@"description" : "Server error response"}},- "tags" : [ "/api/dashboard" ]+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "paper_size" : {+ "default" : "a4",+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "a4", "letter" ]+ }, {+ "type" : "null"+ } ]+ },+ "parameters" : {+ "oneOf" : [ {+ "anyOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be a parameter map with an 'id' key",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "id" ]+ }, {+ "type" : "object",+ "additionalProperties" : { }+ } ]+ }+ }, {+ "description" : "value must be a valid JSON string.",+ "type" : "string"+ } ]+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ ]+ }+ }+ }+ },+ "tags" : [ "/api/dashboard" ]+ }+ },+ "/api/dashboard/{id}/query_metadata" : {+ "get" : {+ "operationId" : "get-api-dashboard-id-query_metadata",+ "summary" : "GET /api/dashboard/{id}/query_metadata",+ "description" : "Get all of the required query metadata for the cards on dashboard.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "anyOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "description" : "String must be a valid 21-character NanoID string.",+ "type" : "string",+ "pattern" : "^[A-Za-z0-9_\\-]{21}$"+ } ]+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/dashboard" ]}},"/api/dashboard/{id}/related" : {@@ -38136,7 +38621,7 @@"get" : {"operationId" : "get-api-notification-admin","summary" : "GET /api/notification/admin",- "description" : "List card-type notifications (alerts) for admin management. Supports pagination (`limit` +\n `offset` query params — handled by the offset-paging middleware), filtering, and sorting.\n\n `last_send_status` filter operates on the latest channel-send task_history row for the\n notification's card (`successful` = latest channel-send succeeded; `failing` = latest\n channel-send failed).\n\n `last_check_status` filter operates on the latest terminal TaskRun for the card — the whole-run\n rollup (`successful` = the run succeeded; `failing` = it failed or was abandoned). This is a\n superset of `last_send_status`: it also catches query failures and heartbeat-abandoned runs that\n never reached the send step. The Failing tab uses `?last_check_status=failing`.\n\n `creatorless=true` selects notifications with no creator or a deactivated creator (the Ownerless\n tab). `creatorless=false` selects the inverse.\n\n `channel` accepts a single string or a repeated query param for multi-select (OR logic).",+ "description" : "List card-type notifications (alerts) for admin management. Supports pagination (`limit` +\n `offset` query params — handled by the offset-paging middleware), filtering, and sorting.\n\n `last_send_status` filter operates on the latest channel-send task_history row for the\n notification (`successful` = latest channel-send succeeded; `failing` = latest channel-send\n failed).\n\n `last_check_status` filter operates on the latest terminal TaskRun for the notification — the\n whole-run rollup (`successful` = the run succeeded; `failing` = it failed or was abandoned). This\n is a superset of `last_send_status`: it also catches query failures and heartbeat-abandoned runs\n that never reached the send step. The Failing tab uses `?last_check_status=failing`.\n\n `creatorless=true` selects notifications with no creator or a deactivated creator (the Ownerless\n tab). `creatorless=false` selects the inverse.\n\n `channel` accepts a single string or a repeated query param for multi-select (OR logic).","parameters" : [ {"in" : "query","name" : "active",@@ -41989,130 +42474,437 @@"name" : "id","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/pulse" ]+ }+ },+ "/api/revision" : {+ "get" : {+ "operationId" : "get-api-revision",+ "summary" : "GET /api/revision",+ "description" : "Get revisions of an object.",+ "parameters" : [ {+ "in" : "query",+ "name" : "id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "entity",+ "required" : true,+ "schema" : {+ "type" : "string",+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/revision" ]+ }+ },+ "/api/revision/revert" : {+ "post" : {+ "operationId" : "post-api-revision-revert",+ "summary" : "POST /api/revision/revert",+ "description" : "Revert an object to a prior revision.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "entity" : {+ "type" : "string",+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "revision_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "id", "entity", "revision_id" ]+ }+ }+ }+ },+ "tags" : [ "/api/revision" ]+ }+ },+ "/api/revision/{entity}/{id}" : {+ "get" : {+ "operationId" : "get-api-revision-entity-id",+ "summary" : "GET /api/revision/{entity}/{id}",+ "description" : "Fetch `Revisions` for an object with ID.",+ "parameters" : [ {+ "in" : "path",+ "name" : "entity",+ "required" : true,+ "schema" : {+ "type" : "string",+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]+ }+ }, {+ "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"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/revision" ]+ }+ },+ "/api/search" : {+ "get" : {+ "operationId" : "get-api-search",+ "summary" : "GET /api/search",+ "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine, `hnsw` (approximate index search, default) or `brute-force` (exact filter-first search); ignored by other engines\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",+ "parameters" : [ {+ "in" : "query",+ "name" : "q",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "context",+ "required" : false,+ "schema" : {+ "default" : "api",+ "type" : "string",+ "enum" : [ "search-bar", "search-app", "command-palette", "entity-picker", "data-picker", "type-filter", "basic-actions", "browse", "embedding-setup", "document", "library", "dependencies", "model-migration", "api", "metabot" ]+ }+ }, {+ "in" : "query",+ "name" : "archived",+ "required" : false,+ "schema" : {+ "default" : false,+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "collection",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "table_db_id",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "models",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "type" : "string",+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]+ }+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "filter_items_in_personal_collection",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ]+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "created_at",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "string",+ "minLength" : 1+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "created_by",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "display_type",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "type" : "string",+ "minLength" : 1+ }+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "last_edited_at",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "string",+ "minLength" : 1+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "last_edited_by",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "model_ancestors",+ "required" : false,+ "schema" : {+ "default" : false,+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}- },- "tags" : [ "/api/pulse" ]- }- },- "/api/revision" : {- "get" : {- "operationId" : "get-api-revision",- "summary" : "GET /api/revision",- "description" : "Get revisions of an object.",- "parameters" : [ {+ }, {"in" : "query",- "name" : "id",- "required" : true,+ "name" : "search_engine",+ "required" : false,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ }}, {"in" : "query",- "name" : "entity",- "required" : true,+ "name" : "vector_search_strategy",+ "required" : false,"schema" : {- "type" : "string",- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]+ "oneOf" : [ {+ "type" : "string",+ "enum" : [ "hnsw", "brute-force" ]+ }, {+ "type" : "null"+ } ]}- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ }, {+ "in" : "query",+ "name" : "search_native_query",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}- },- "tags" : [ "/api/revision" ]- }- },- "/api/revision/revert" : {- "post" : {- "operationId" : "post-api-revision-revert",- "summary" : "POST /api/revision/revert",- "description" : "Revert an object to a prior revision.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ }, {+ "in" : "query",+ "name" : "verified",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}- },- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "entity" : {- "type" : "string",- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]- },- "id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "revision_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }- },- "required" : [ "id", "entity", "revision_id" ]+ }, {+ "in" : "query",+ "name" : "ids",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1}- }+ }, {+ "type" : "null"+ } ]}- },- "tags" : [ "/api/revision" ]- }- },- "/api/revision/{entity}/{id}" : {- "get" : {- "operationId" : "get-api-revision-entity-id",- "summary" : "GET /api/revision/{entity}/{id}",- "description" : "Fetch `Revisions` for an object with ID.",- "parameters" : [ {- "in" : "path",- "name" : "entity",- "required" : true,+ }, {+ "in" : "query",+ "name" : "calculate_available_models",+ "required" : false,"schema" : {- "type" : "string",- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ]+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}}, {- "in" : "path",- "name" : "id",- "required" : true,+ "in" : "query",+ "name" : "include_dashboard_questions",+ "required" : false,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "default" : false,+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "include_metadata",+ "required" : false,+ "schema" : {+ "default" : false,+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "non_temporal_dim_ids",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "string",+ "minLength" : 1+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "has_temporal_dim",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }} ],"responses" : {"2XX" : {@@ -42125,14 +42917,14 @@"description" : "Server error response"}},- "tags" : [ "/api/revision" ]+ "tags" : [ "/api/search" ]}},- "/api/search" : {+ "/api/search/debug" : {"get" : {- "operationId" : "get-api-search",- "summary" : "GET /api/search",- "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine, `hnsw` (approximate index search, default) or `brute-force` (exact filter-first search); ignored by other engines\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",+ "operationId" : "get-api-search-debug",+ "summary" : "GET /api/search/debug",+ "description" : "Superuser-only. Explain why `expected_result_id` / `expected_result_type` does not appear in the results of\n the given search query. Accepts every `GET /api/search` parameter plus the two expected-result parameters, and\n returns `{:type ..., :details ...}` for the first stage that drops the item: `not-searchable`,\n `missing-from-index`, `not-permitted`, `filtered`, `not-matching`, or the terminal `matched` / `ranked-out`.\n\n - `for_user_id`: diagnose from another user's perspective (defaults to you). Permission and visibility checks run\n as that user, so a `not-permitted` result means *they* can't see the item.\n\n Not supported for `indexed-entity` (its id is compound).","parameters" : [ {"in" : "query","name" : "q",@@ -42420,6 +43212,36 @@"type" : "null"} ]}+ }, {+ "in" : "query",+ "name" : "expected_result_type",+ "required" : true,+ "schema" : {+ "type" : "string",+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]+ }+ }, {+ "in" : "query",+ "name" : "expected_result_id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "for_user_id",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }} ],"responses" : {"2XX" : {diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.mdindex 512a64cf2ae..a8f4cfaa238 100644--- a/docs/configuring-metabase/config-template.md+++ b/docs/configuring-metabase/config-template.md@@ -157,6 +157,7 @@ config:enable-pivoted-exports: trueenable-public-sharing: trueenable-xrays: true+ fingerprint-max-fields-per-table: 10000follow-up-email-sent: falsegoogle-auth-auto-create-accounts-domain: nullgoogle-auth-client-id: null@@ -275,6 +276,7 @@ config:saml-keystore-path: nullsaml-slo-enabled: falsesaml-user-provisioning-enabled: true+ scan-max-fields-per-table: 10000scim-enabled: nullsdk-encryption-validation-key: nullsearch-language: null@@ -313,6 +315,7 @@ config:subscription-allowed-domains: nullsurveys-enabled: truesync-leaf-fields-limit: 1000+ sync-max-fields-per-table: 10000synchronous-batch-updates: falsethread-interrupt-escalation-timeout-ms: 0transform-run-job-sql-concurrency: 3diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.mdindex bd6ec6ca5f6..92e843913a8 100644--- a/docs/configuring-metabase/environment-variables.md+++ b/docs/configuring-metabase/environment-variables.md@@ -784,6 +784,16 @@ Enable admins to create publicly viewable links (and embeddable iframes) for QueAllow users to explore data using X-rays.+### `MB_FINGERPRINT_MAX_FIELDS_PER_TABLE`++- Type: integer+- Default: `10000`+- [Exported as](../installation-and-operation/serialization.md): `fingerprint-max-fields-per-table`.++Maximum number of fields per table to fingerprint. If a table has more eligible fields than this, the rest are+ skipped during fingerprinting analysis -- loading that many fields into memory at once can exhaust the heap (this has+ OOM'd instances syncing document databases like MongoDB with very large or dynamic schemas).+### `MB_FOLLOW_UP_EMAIL_SENT`- Type: boolean@@ -1869,6 +1879,16 @@ Determines what happens when a user logs in via SAML and doesn't have a MetabaseWhen set to `true`, users who log in via SAML will automatically get a Metabase account if they don't have one, or get their existing account reactivated. When set to `false`, only users with active Metabase accounts can log in via SAML.+### `MB_SCAN_MAX_FIELDS_PER_TABLE`++- Type: integer+- Default: `10000`+- [Exported as](../installation-and-operation/serialization.md): `scan-max-fields-per-table`.++Maximum number of fields per table to scan for field values. If a table has more active fields than this, the rest+ are skipped when scanning field values -- scanning that many fields would load them all into memory and, on non-SQL+ drivers like MongoDB, issue a warehouse request per field.+### `MB_SCIM_ENABLED`- Type: boolean@@ -2216,6 +2236,16 @@ Enable or disable surveys.Maximum number of leaf fields synced per collection of document database. Currently relevant for Mongo. Not to be confused with total number of synced fields. For every chosen leaf field, all intermediate fields from root to leaf are synced as well.+### `MB_SYNC_MAX_FIELDS_PER_TABLE`++- Type: integer+- Default: `10000`+- [Exported as](../installation-and-operation/serialization.md): `sync-max-fields-per-table`.++Maximum number of fields per table to sync as :model/Field rows. If a table's warehouse schema has more fields than+ this, only the first (by name) are synced and the rest are skipped -- keeps document databases with very large or+ dynamic schemas (e.g. MongoDB) from creating an unbounded number of Fields.+### `MB_SYNCHRONOUS_BATCH_UPDATES`- Type: boolean