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 (#73341)

github-automation-metabasee08f1895cff0
diff --git a/docs/api.json b/docs/api.json
index 6b08dab8605..45c24f9fcf5 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -5170,6 +5170,31 @@
"type" : "string",
"enum" : [ "default", "write-data" ]
},
+ "metabase.embedding-rest.api.theme.EmbeddingTheme" : {
+ "type" : "object",
+ "properties" : {
+ "created_at" : { },
+ "entity_id" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "settings" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "entity_id", "name", "settings", "created_at", "updated_at" ]
+ },
"metabase.frontend-errors.api.frontend-error-type" : {
"type" : "string",
"enum" : [ "component-crash", "chart-render-error" ]
@@ -30112,6 +30137,304 @@
"tags" : [ "/api/email" ]
}
},
+ "/api/embed-theme" : {
+ "get" : {
+ "operationId" : "get-api-embed-theme",
+ "summary" : "GET /api/embed-theme",
+ "description" : "Fetch a list of all embedding themes.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ },
+ "post" : {
+ "operationId" : "post-api-embed-theme",
+ "summary" : "POST /api/embed-theme",
+ "description" : "Create a new embedding theme.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "settings" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "name", "settings" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed-theme/seed-defaults" : {
+ "post" : {
+ "operationId" : "post-api-embed-theme-seed-defaults",
+ "summary" : "POST /api/embed-theme/seed-defaults",
+ "description" : "Seed default embedding themes on first call, using the payloads built by the frontend from the\n `METABASE_LIGHT_THEME` / `METABASE_DARK_THEME` constants.\n\n Idempotent: guarded by the `default-embedding-themes-seeded` setting. Once flipped, subsequent calls\n are no-ops even if the admin has since deleted the seeded themes, so deletions are preserved.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "themes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "settings" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "name", "settings" ]
+ }
+ }
+ },
+ "required" : [ "themes" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed-theme/{id}" : {
+ "get" : {
+ "operationId" : "get-api-embed-theme-id",
+ "summary" : "GET /api/embed-theme/{id}",
+ "description" : "Fetch a single embedding theme 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",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ },
+ "put" : {
+ "operationId" : "put-api-embed-theme-id",
+ "summary" : "PUT /api/embed-theme/{id}",
+ "description" : "Update an embedding theme.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-embed-theme-id",
+ "summary" : "DELETE /api/embed-theme/{id}",
+ "description" : "Delete an embedding theme.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
+ "/api/embed-theme/{id}/copy" : {
+ "post" : {
+ "operationId" : "post-api-embed-theme-id-copy",
+ "summary" : "POST /api/embed-theme/{id}/copy",
+ "description" : "Copy an embedding theme.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.embedding-rest.api.theme.EmbeddingTheme"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed-theme" ]
+ }
+ },
"/api/embed/card/{token}" : {
"get" : {
"operationId" : "get-api-embed-card-token",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 164ac25e2fd..f4f7bd94241 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -92,6 +92,7 @@ config:
linkedin.com,
twitter.com,
x.com
+ analytics-pii-retention-enabled: false
anon-tracking-enabled: true
api-key: null
application-colors: {}
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index c6f5d68268a..6dcff841d1a 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -101,13 +101,22 @@ x.com`
Allowed iframe hosts.
+### `MB_ANALYTICS_PII_RETENTION_ENABLED`
+
+- Type: boolean
+- Default: `false`
+- [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.
+
### `MB_ANON_TRACKING_ENABLED`
- Type: boolean
- Default: `true`
- [Configuration file name](./config-file.md): `anon-tracking-enabled`
-Enable the collection of anonymous usage data in order to help us improve.
+Enable the collection of anonymous usage data in order to help Metabase improve..
### `MB_API_KEY`