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

github-automation-metabase195fff76b21c
diff --git a/docs/api.json b/docs/api.json
index a092970e62a..678fdf20ff0 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -8668,7 +8668,7 @@
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot" ]
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "metric", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
@@ -11211,7 +11211,7 @@
"metabase.lib.schema.validate.source-entity-type" : {
"description" : "The type of the source entity causing an error.",
"type" : "string",
- "enum" : [ "table", "card" ]
+ "enum" : [ "table", "card", "transform" ]
},
"metabase.lib.schema.validate.validate-error-type" : {
"type" : "string",
@@ -28406,6 +28406,104 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "branch" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "force" : {
+ "type" : "boolean"
+ },
+ "merge" : {
+ "type" : "boolean"
+ },
+ "message" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "branch" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/remote-sync" ]
+ }
+ },
+ "/api/ee/remote-sync/export-preflight" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-export-preflight",
+ "summary" : "GET /api/ee/remote-sync/export-preflight",
+ "description" : "Dry-run preview of what pushing the current state would do given the live remote branch, without\n writing anything. Drives the UI's push decision (force / new branch / merge).\n\n Returns:\n - has_changes: whether the remote branch has advanced beyond the last synced version\n - clean: whether a 3-way merge would apply with no conflicts\n - conflicts: human-readable labels of the entities that conflict (empty when clean)\n - summary: counts of remote changes a merge would fold in\n - reason: \"history-rewritten\" when the remote was force-pushed/rebased so no merge base exists\n\n Requires superuser permissions.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "branch",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "clean" : {
+ "type" : "boolean"
+ },
+ "conflicts" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "has_changes" : {
+ "type" : "boolean"
+ },
+ "reason" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "summary" : {
+ "type" : "object",
+ "properties" : {
+ "added" : {
+ "type" : "integer"
+ },
+ "removed" : {
+ "type" : "integer"
+ },
+ "updated" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "added", "updated", "removed" ]
+ }
+ },
+ "required" : [ "has_changes", "clean", "conflicts", "summary", "reason" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
"tags" : [ "/api/ee/remote-sync" ]
}
},
@@ -28524,10 +28622,18 @@
"type" : "string",
"minLength" : 1
},
+ "expected_branch" : {
+ "type" : "string",
+ "minLength" : 1
+ },
"force" : {
"type" : "boolean"
+ },
+ "merge" : {
+ "type" : "boolean"
}
- }
+ },
+ "required" : [ "expected_branch" ]
}
}
}
@@ -31807,6 +31913,14 @@
"items" : {
"type" : "object",
"properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"database_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
@@ -31861,7 +31975,7 @@
"post" : {
"operationId" : "post-api-ee-workspace-manager",
"summary" : "POST /api/ee/workspace-manager",
- "description" : "Create a new Workspace (name only, no databases).",
+ "description" : "Create a new Workspace attached to the given databases (each must be eligible\n for workspaces) and provision it (blocking).",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -31920,267 +32034,14 @@
"items" : {
"type" : "object",
"properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "input_schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "output_namespace" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "unprovisioned", "provisioning", "provisioned", "deprovisioning" ]
- }
- },
- "required" : [ "database_id", "input_schemas", "output_namespace", "status" ],
- "additionalProperties" : false
- }
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "updated_at" : {
- "anyOf" : [ { }, { } ]
- }
- },
- "required" : [ "id", "name", "creator", "created_at", "updated_at" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "name" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace-manager" ]
- }
- },
- "/api/ee/workspace-manager/{id}" : {
- "get" : {
- "operationId" : "get-api-ee-workspace-manager-id",
- "summary" : "GET /api/ee/workspace-manager/{id}",
- "description" : "Get a single Workspace 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" : {
- "type" : "object",
- "properties" : {
- "created_at" : {
- "anyOf" : [ { }, { } ]
- },
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "type" : "string",
- "minLength" : 1
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "last_name" : {
+ "database" : {
"oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "first_name", "last_name", "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "databases" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "input_schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "output_namespace" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "unprovisioned", "provisioning", "provisioned", "deprovisioning" ]
- }
- },
- "required" : [ "database_id", "input_schemas", "output_namespace", "status" ],
- "additionalProperties" : false
- }
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "updated_at" : {
- "anyOf" : [ { }, { } ]
- }
- },
- "required" : [ "id", "name", "creator", "created_at", "updated_at" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/workspace-manager" ]
- },
- "put" : {
- "operationId" : "put-api-ee-workspace-manager-id",
- "summary" : "PUT /api/ee/workspace-manager/{id}",
- "description" : "Update a workspace's name.",
- "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" : "object",
- "properties" : {
- "created_at" : {
- "anyOf" : [ { }, { } ]
- },
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "type" : "string",
- "minLength" : 1
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "first_name", "last_name", "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "databases" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
"database_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
@@ -32235,266 +32096,32 @@
"schema" : {
"type" : "object",
"properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "minItems" : 1
+ },
"name" : {
"type" : "string",
"minLength" : 1
}
},
+ "required" : [ "name", "database_ids" ],
"additionalProperties" : false
}
}
}
},
"tags" : [ "/api/ee/workspace-manager" ]
- },
- "delete" : {
- "operationId" : "delete-api-ee-workspace-manager-id",
- "summary" : "DELETE /api/ee/workspace-manager/{id}",
- "description" : "Delete a Workspace. Deprovisions all databases first (blocking).",
- "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" : "object",
- "properties" : {
- "deleted" : {
- "type" : "boolean"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "id", "deleted" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/workspace-manager" ]
}
},
- "/api/ee/workspace-manager/{id}/config" : {
+ "/api/ee/workspace-manager/{id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-manager-id-config",
- "summary" : "GET /api/ee/workspace-manager/{id}/config",
- "description" : "Download the workspace's developer-instance config as a YAML file. 409 if any\n of the workspace's databases is not `:provisioned`.",
- "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" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "headers" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "status" : {
- "const" : 200
- }
- },
- "required" : [ "status", "headers", "body" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/workspace-manager" ]
- }
- },
- "/api/ee/workspace-manager/{id}/database" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-manager-id-database",
- "summary" : "POST /api/ee/workspace-manager/{id}/database",
- "description" : "Add a database to a workspace and provision it immediately (blocking).",
- "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" : "object",
- "properties" : {
- "created_at" : {
- "anyOf" : [ { }, { } ]
- },
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "common_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "type" : "string",
- "minLength" : 1
- },
- "first_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "last_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "first_name", "last_name", "email" ],
- "additionalProperties" : false
- }, {
- "type" : "null"
- } ]
- },
- "databases" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "input_schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "output_namespace" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "unprovisioned", "provisioning", "provisioned", "deprovisioning" ]
- }
- },
- "required" : [ "database_id", "input_schemas", "output_namespace", "status" ],
- "additionalProperties" : false
- }
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "updated_at" : {
- "anyOf" : [ { }, { } ]
- }
- },
- "required" : [ "id", "name", "creator", "created_at", "updated_at" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "input_schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- }
- },
- "required" : [ "database_id", "input_schemas" ],
- "additionalProperties" : false
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace-manager" ]
- }
- },
- "/api/ee/workspace-manager/{id}/database/{db-id}" : {
- "put" : {
- "operationId" : "put-api-ee-workspace-manager-id-database-db-id",
- "summary" : "PUT /api/ee/workspace-manager/{id}/database/{db-id}",
- "description" : "Update a database's input namespaces. Deprovisions the old config and reprovisions\n with the new one (blocking).",
+ "operationId" : "get-api-ee-workspace-manager-id",
+ "summary" : "GET /api/ee/workspace-manager/{id}",
+ "description" : "Get a single Workspace by id.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -32504,15 +32131,6 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "db-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -32571,6 +32189,14 @@
"items" : {
"type" : "object",
"properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"database_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
@@ -32619,32 +32245,12 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "input_schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- }
- },
- "required" : [ "input_schemas" ],
- "additionalProperties" : false
- }
- }
- }
- },
"tags" : [ "/api/ee/workspace-manager" ]
},
- "delete" : {
- "operationId" : "delete-api-ee-workspace-manager-id-database-db-id",
- "summary" : "DELETE /api/ee/workspace-manager/{id}/database/{db-id}",
- "description" : "Deprovision and remove a database from a workspace (blocking).",
+ "put" : {
+ "operationId" : "put-api-ee-workspace-manager-id",
+ "summary" : "PUT /api/ee/workspace-manager/{id}",
+ "description" : "Update a workspace's name.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -32654,15 +32260,6 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "db-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -32721,6 +32318,14 @@
"items" : {
"type" : "object",
"properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
"database_id" : {
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
@@ -32769,6 +32374,118 @@
"description" : "Server error response"
}
},
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/workspace-manager" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-ee-workspace-manager-id",
+ "summary" : "DELETE /api/ee/workspace-manager/{id}",
+ "description" : "Delete a Workspace. Deprovisions all databases first (blocking).",
+ "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" : "object",
+ "properties" : {
+ "deleted" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "deleted" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/workspace-manager" ]
+ }
+ },
+ "/api/ee/workspace-manager/{id}/config" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace-manager-id-config",
+ "summary" : "GET /api/ee/workspace-manager/{id}/config",
+ "description" : "Download the workspace's developer-instance config as a YAML file. 409 if any\n of the workspace's databases is not `:provisioned`.",
+ "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" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "status" : {
+ "const" : 200
+ }
+ },
+ "required" : [ "status", "headers", "body" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
"tags" : [ "/api/ee/workspace-manager" ]
}
},
@@ -38967,6 +38684,82 @@
"tags" : [ "/api/notify" ]
}
},
+ "/api/oauth/authorizations" : {
+ "get" : {
+ "operationId" : "get-api-oauth-authorizations",
+ "summary" : "GET /api/oauth/authorizations",
+ "description" : "List OAuth dynamic client registration events (registered, approved, or denied), newest first.\n Joins client info and, for decision events, the deciding user. Superuser only.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "client-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "event-type",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "registered", "approved", "denied" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "total", "limit", "offset", "data" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/oauth" ]
+ }
+ },
"/api/permissions/graph" : {
"get" : {
"operationId" : "get-api-permissions-graph",
@@ -45760,6 +45553,9 @@
"type" : "null"
} ]
},
+ "can_read" : {
+ "type" : "boolean"
+ },
"source_type" : {
"type" : "string"
},
@@ -45975,6 +45771,9 @@
"minimum" : 1
}
},
+ "can_write" : {
+ "type" : "boolean"
+ },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -45983,6 +45782,9 @@
"type" : "null"
} ]
},
+ "can_execute" : {
+ "type" : "boolean"
+ },
"source" : { },
"last_checkpoint_value" : {
"oneOf" : [ {
@@ -46096,6 +45898,9 @@
"type" : "null"
} ]
},
+ "can_read" : {
+ "type" : "boolean"
+ },
"source_type" : {
"type" : "string"
},
@@ -46311,6 +46116,9 @@
"minimum" : 1
}
},
+ "can_write" : {
+ "type" : "boolean"
+ },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -46319,6 +46127,9 @@
"type" : "null"
} ]
},
+ "can_execute" : {
+ "type" : "boolean"
+ },
"source" : { },
"last_checkpoint_value" : {
"oneOf" : [ {
@@ -48269,6 +48080,9 @@
"type" : "null"
} ]
},
+ "can_read" : {
+ "type" : "boolean"
+ },
"source_type" : {
"type" : "string"
},
@@ -48484,6 +48298,9 @@
"minimum" : 1
}
},
+ "can_write" : {
+ "type" : "boolean"
+ },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -48492,6 +48309,9 @@
"type" : "null"
} ]
},
+ "can_execute" : {
+ "type" : "boolean"
+ },
"source" : { },
"last_checkpoint_value" : {
"oneOf" : [ {
@@ -48613,6 +48433,9 @@
"type" : "null"
} ]
},
+ "can_read" : {
+ "type" : "boolean"
+ },
"source_type" : {
"type" : "string"
},
@@ -48828,6 +48651,9 @@
"minimum" : 1
}
},
+ "can_write" : {
+ "type" : "boolean"
+ },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -48836,6 +48662,9 @@
"type" : "null"
} ]
},
+ "can_execute" : {
+ "type" : "boolean"
+ },
"source" : { },
"last_checkpoint_value" : {
"oneOf" : [ {
@@ -49094,6 +48923,9 @@
"type" : "null"
} ]
},
+ "can_read" : {
+ "type" : "boolean"
+ },
"source_type" : {
"type" : "string"
},
@@ -49309,6 +49141,9 @@
"minimum" : 1
}
},
+ "can_write" : {
+ "type" : "boolean"
+ },
"collection_id" : {
"oneOf" : [ {
"type" : "integer",
@@ -49317,6 +49152,9 @@
"type" : "null"
} ]
},
+ "can_execute" : {
+ "type" : "boolean"
+ },
"source" : { },
"last_checkpoint_value" : {
"oneOf" : [ {
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 092a68cd7fa..512a64cf2ae 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -320,5 +320,9 @@ config:
transforms-enabled: false
unaggregated-query-row-limit: null
uploads-settings: null
+ usage-metadata-enabled: false
+ usage-metadata-last-completed-day: null
+ usage-metadata-retention-days: 90
+ usage-metadata-schedule: 0 0 2 * * ? *
user-visibility: all
```
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 9ef6f4aada7..bd6ec6ca5f6 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -2325,6 +2325,34 @@ Upload settings.
Prefix for upload table names.
+### `MB_USAGE_METADATA_ENABLED`
+
+- Type: boolean
+- Default: `false`
+
+Whether usage-driven metadata batch processing is enabled.
+
+### `MB_USAGE_METADATA_LAST_COMPLETED_DAY`
+
+- Type: string
+- Default: `null`
+
+Internal watermark for the last completed usage metadata day.
+
+### `MB_USAGE_METADATA_RETENTION_DAYS`
+
+- Type: integer
+- Default: `90`
+
+How many days of usage metadata rollups to retain.
+
+### `MB_USAGE_METADATA_SCHEDULE`
+
+- Type: string
+- Default: `0 0 2 * * ? *`
+
+Cron schedule (in UTC) for usage metadata batch processing.
+
### `MB_USER_VISIBILITY`
> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
diff --git a/docs/usage-and-performance-tools/usage-analytics-reference.md b/docs/usage-and-performance-tools/usage-analytics-reference.md
index bc2b243e2fe..c430b94a20c 100644
--- a/docs/usage-and-performance-tools/usage-analytics-reference.md
+++ b/docs/usage-and-performance-tools/usage-analytics-reference.md
@@ -672,6 +672,7 @@ The Query Source column on the [Query log](#query-log) model takes one of:
- embedded-xlsx-download
- json-download
- map-tiles
+- metric
- public-csv-download
- public-dashboard
- public-json-download