Skip to content

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

Auto-update documentation for master (#73787)

github-automation-metabasea4f22e47b76b
diff --git a/docs/api.json b/docs/api.json
index e7a2b1b0db9..7289bc72fb2 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -43,6 +43,31 @@
}
},
"required" : [ "url", "created_at", "sync_started_at", "created_by_id", "db_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "created_at" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "created_by_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "db_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "sync_started_at" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "url" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "url", "created_at", "sync_started_at", "created_by_id", "db_id" ]
}, {
"type" : "object",
"properties" : {
@@ -2139,6 +2164,128 @@
},
"required" : [ "min", "fixed" ]
},
+ "metabase-enterprise.serialization.schema.database-info" : {
+ "type" : "object",
+ "properties" : {
+ "engine" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-database-id"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "engine" ]
+ },
+ "metabase-enterprise.serialization.schema.external-database-id" : {
+ "type" : "string"
+ },
+ "metabase-enterprise.serialization.schema.external-field-id" : { },
+ "metabase-enterprise.serialization.schema.external-table-id" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "type" : "string"
+ }, {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "metabase-enterprise.serialization.schema.field-info" : {
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-field-id"
+ },
+ "coercion_strategy" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-table-id"
+ },
+ "nfc_path" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "effective_type" : {
+ "type" : "string"
+ },
+ "parent_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-field-id"
+ },
+ "database_type" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "fk_target_field_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-field-id"
+ }
+ },
+ "required" : [ "id", "table_id", "name", "base_type" ]
+ },
+ "metabase-enterprise.serialization.schema.metadata-export-response" : {
+ "type" : "object",
+ "properties" : {
+ "databases" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.database-info"
+ }
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.field-info"
+ }
+ },
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.table-info"
+ }
+ }
+ }
+ },
+ "metabase-enterprise.serialization.schema.table-info" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-database-id"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.external-table-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "db_id", "name" ]
+ },
"metabase-enterprise.support-access-grants.schema.create-grant-request" : {
"description" : "Schema for POST /api/ee/support-access-grants request body.",
"type" : "object",
@@ -14064,146 +14211,6 @@
"required" : [ "enabled" ]
}
},
- "metabase.warehouses-rest.api.database-info" : {
- "type" : "object",
- "properties" : {
- "engine" : {
- "type" : "string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "engine" ]
- },
- "metabase.warehouses-rest.api.databases-metadata-response" : {
- "type" : "object",
- "properties" : {
- "databases" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.database-info"
- }
- },
- "fields" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.field-info"
- }
- },
- "tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.table-info"
- }
- }
- },
- "required" : [ "databases", "tables", "fields" ]
- },
- "metabase.warehouses-rest.api.field-info" : {
- "type" : "object",
- "properties" : {
- "base_type" : {
- "type" : "string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "coercion_strategy" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- },
- "semantic_type" : {
- "type" : "string"
- },
- "table_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "effective_type" : {
- "type" : "string"
- },
- "parent_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "database_type" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "fk_target_field_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }
- },
- "required" : [ "id", "table_id", "name", "base_type" ]
- },
- "metabase.warehouses-rest.api.field-values-info" : {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "has_more_values" : {
- "type" : "boolean"
- },
- "human_readable_values" : {
- "type" : "array",
- "items" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "values" : {
- "type" : "array",
- "items" : {
- "type" : "array",
- "items" : { }
- }
- }
- },
- "required" : [ "field_id", "values", "has_more_values" ]
- },
- "metabase.warehouses-rest.api.field-values-response" : {
- "type" : "object",
- "properties" : {
- "field_values" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.field-values-info"
- }
- }
- },
- "required" : [ "field_values" ]
- },
- "metabase.warehouses-rest.api.table-info" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "description" : {
- "type" : "string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "db_id", "name" ]
- },
"metabase.xrays.api.automagic-dashboards.base-64-encoded-json" : {
"description" : "form-encoded base-64-encoded JSON"
},
@@ -21440,60 +21447,6 @@
"tags" : [ "/api/database" ]
}
},
- "/api/database/field-values" : {
- "get" : {
- "operationId" : "get-api-database-field-values",
- "summary" : "GET /api/database/field-values",
- "description" : "Get sampled field values for every field in the instance, streamed as a single\n `{\"field_values\": [...]}` document. Each entry carries `field_id`, `values`,\n optional `human_readable_values`, and `has_more_values`.\n\n Only unconstrained (`:full`) FieldValues are included — sandboxed, impersonation, and\n linked-filter variants are user-specific and would bypass their own enforcement\n mechanisms in a bulk export. Pair with `GET /api/database/metadata` to resolve\n `field_id` to table and field names. Response is streamed for efficiency with large\n schemas.\n\n Admin-only: this endpoint exposes cached values computed over the unrestricted\n dataset, so it would leak data past sandbox / impersonation rules if served to\n regular users.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.field-values-response"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/database" ]
- }
- },
- "/api/database/metadata" : {
- "get" : {
- "operationId" : "get-api-database-metadata",
- "summary" : "GET /api/database/metadata",
- "description" : "Get metadata (databases, tables, and fields) for all databases visible to the current user.\n Returns a flat structure with three arrays: databases, tables, and fields.\n Response is streamed for efficiency with large schemas.\n\n Requires `View data` → `Can view` and `Create queries` → `Query builder only` (or\n `Query builder and native`) permissions on each database and table.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.databases-metadata-response"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/database" ]
- }
- },
"/api/database/sample_database" : {
"post" : {
"operationId" : "post-api-database-sample_database",
@@ -27090,6 +27043,20 @@
"items" : {
"type" : "object",
"properties" : {
+ "sanitized_user_agent" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_path" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"user" : {
"oneOf" : [ {
"type" : "object",
@@ -27122,6 +27089,13 @@
"type" : "null"
} ]
},
+ "embedding_hostname" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"summary" : {
"oneOf" : [ {
"type" : "string"
@@ -27189,9 +27163,16 @@
"description" : "value must be an integer greater or equal to than zero.",
"type" : "integer",
"minimum" : 0
+ },
+ "user_agent" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "conversation_id", "created_at", "summary", "message_count", "user_message_count", "assistant_message_count", "total_tokens", "last_message_at", "profile_id", "search_count", "query_count", "ip_address", "user" ]
+ "required" : [ "conversation_id", "created_at", "summary", "message_count", "user_message_count", "assistant_message_count", "total_tokens", "last_message_at", "profile_id", "search_count", "query_count", "ip_address", "embedding_hostname", "embedding_path", "user_agent", "sanitized_user_agent", "user" ]
}
},
"limit" : {
@@ -27321,6 +27302,20 @@
"required" : [ "tool", "call_id", "message_id", "query_id", "query_type", "sql", "mbql", "display", "database_id", "tables" ]
}
},
+ "sanitized_user_agent" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_path" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"slack_permalink" : {
"oneOf" : [ {
"type" : "string"
@@ -27360,6 +27355,13 @@
"type" : "null"
} ]
},
+ "embedding_hostname" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"summary" : {
"oneOf" : [ {
"type" : "string"
@@ -27498,6 +27500,13 @@
"type" : "integer",
"minimum" : 0
},
+ "user_agent" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"chat_messages" : {
"type" : "array",
"items" : {
@@ -27506,7 +27515,7 @@
}
}
},
- "required" : [ "conversation_id", "created_at", "summary", "user", "message_count", "total_tokens", "profile_id", "slack_permalink", "chat_messages", "queries", "search_count", "query_count", "ip_address", "feedback" ]
+ "required" : [ "conversation_id", "created_at", "summary", "user", "message_count", "total_tokens", "profile_id", "slack_permalink", "chat_messages", "queries", "search_count", "query_count", "ip_address", "embedding_hostname", "embedding_path", "user_agent", "sanitized_user_agent", "feedback" ]
}
}
}
@@ -29912,6 +29921,69 @@
"tags" : [ "/api/ee/serialization" ]
}
},
+ "/api/ee/serialization/metadata/export" : {
+ "get" : {
+ "operationId" : "get-api-ee-serialization-metadata-export",
+ "summary" : "GET /api/ee/serialization/metadata/export",
+ "description" : "Get warehouse metadata (databases, tables, and fields) for all databases visible to the\n current user, with all references emitted in serdes-portable form (database names, table\n `[db schema name]` tuples, field `[db schema table name | nfc-path...]` tuples).\n\n Sections must be opted into with the `with-databases`, `with-tables`, and `with-fields`\n query parameters — they all default to `false`. The response is streamed for efficiency\n with large schemas.\n\n Requires `View data` → `Can view` and `Create queries` → `Query builder only` (or\n `Query builder and native`) permissions on each database and table.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "with-databases",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-tables",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-fields",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.serialization.schema.metadata-export-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/serialization" ]
+ }
+ },
"/api/ee/stale/{id}" : {
"get" : {
"operationId" : "get-api-ee-stale-id",
@@ -32053,6 +32125,64 @@
"tags" : [ "/api/embed" ]
}
},
+ "/api/field/table-ids" : {
+ "post" : {
+ "operationId" : "post-api-field-table-ids",
+ "summary" : "POST /api/field/table-ids",
+ "description" : "Get unique Table IDs for a list of Field IDs.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "table_ids" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "field_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "required" : [ "field_ids" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/field" ]
+ }
+ },
"/api/field/{id}" : {
"get" : {
"operationId" : "get-api-field-id",
@@ -32938,11 +33068,11 @@
"tags" : [ "/api/ldap" ]
}
},
- "/api/llm/extract-tables" : {
+ "/api/llm/extract-sources" : {
"post" : {
- "operationId" : "post-api-llm-extract-tables",
- "summary" : "POST /api/llm/extract-tables",
- "description" : "Parse SQL and return referenced tables with their columns.\n\n Uses Macaw to parse the SQL, resolves table names to IDs,\n and returns permission-filtered tables with column metadata.\n\n This is a lightweight endpoint that does not trigger fingerprinting\n or field value fetching.",
+ "operationId" : "post-api-llm-extract-sources",
+ "summary" : "POST /api/llm/extract-sources",
+ "description" : "Parse native query sources and return referenced tables and cards/models.\n\n Uses Macaw to parse the SQL, resolves table names to IDs,\n and returns permission-filtered tables with column metadata. Card and model\n references are extracted from native query template tags.\n\n This is a lightweight endpoint that does not trigger fingerprinting\n or field value fetching.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -32952,6 +33082,13 @@
"schema" : {
"type" : "object",
"properties" : {
+ "card_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
"tables" : {
"type" : "array",
"items" : {
@@ -33039,7 +33176,7 @@
}
}
},
- "required" : [ "tables" ]
+ "required" : [ "tables", "card_ids" ]
}
}
}
@@ -33063,6 +33200,22 @@
},
"sql" : {
"type" : "string"
+ },
+ "template_tags" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "card-id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
+ }
}
},
"required" : [ "database_id", "sql" ]
@@ -34165,11 +34318,27 @@
"post" : {
"operationId" : "post-api-metabot-feedback",
"summary" : "POST /api/metabot/feedback",
- "description" : "Persist Metabot feedback locally and proxy it to Harbormaster.",
+ "description" : "Persist Metabot feedback.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "null"
+ },
+ "status" : {
+ "const" : 204
+ }
+ },
+ "required" : [ "status", "body" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34859,6 +35028,75 @@
"tags" : [ "/api/metabot/slack" ]
}
},
+ "/api/metabot/source-feedback" : {
+ "post" : {
+ "operationId" : "post-api-metabot-source-feedback",
+ "summary" : "POST /api/metabot/source-feedback",
+ "description" : "Persist Metabot source feedback.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "null"
+ },
+ "status" : {
+ "const" : 204
+ }
+ },
+ "required" : [ "status", "body" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "message_id" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabot_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "positive" : {
+ "type" : "boolean"
+ },
+ "source_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "source_type" : {
+ "type" : "string",
+ "enum" : [ "table", "card", "model" ]
+ }
+ },
+ "required" : [ "metabot_id", "message_id", "source_id", "source_type", "positive" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot" ]
+ }
+ },
"/api/metric" : {
"get" : {
"operationId" : "get-api-metric",
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 9daa6d41e2f..519753395a3 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -108,7 +108,7 @@ Allowed iframe hosts.
- [Exported as](../installation-and-operation/serialization.md): `analytics-pii-retention-enabled`.
- [Configuration file name](./config-file.md): `analytics-pii-retention-enabled`
-Enable logging of embed path, query parameters, user agent, and IP address of who views your internal data and embeds. This information will be shown in your usage analytics.
+Enable logging of embed path, query parameters, user agent, IP address, and Metabot conversation metadata for users of your internal data and embeds. This information will be shown in your usage analytics.
### `MB_ANON_TRACKING_ENABLED`