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 (#68820)
github-automation-metabase50c809f3fa8d
diff --git a/docs/api.json b/docs/api.jsonindex 0311280fdec..78cd14cae5f 100644--- a/docs/api.json+++ b/docs/api.json@@ -1921,6 +1921,683 @@},"required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ]},+ "metabase-enterprise.metabot-v3.agent-api.api.construct-query-metric-request" : {+ "description" : "Request schema for constructing a query from a metric.\n Only supports filters and group_by (aggregation is defined by the metric).",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "filters" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"+ }+ }, {+ "type" : "null"+ } ]+ },+ "group_by" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"+ }+ }, {+ "type" : "null"+ } ]+ },+ "metric_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "metric_id" ]+ }, {+ "type" : "object",+ "properties" : { }+ } ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.construct-query-request" : {+ "description" : "Request schema for /v1/construct-query. Accepts either table_id or metric_id.",+ "anyOf" : [ {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-table-request"+ }, {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-metric-request"+ } ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.construct-query-response" : {+ "description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",+ "type" : "object",+ "properties" : {+ "query" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "query" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.construct-query-table-request" : {+ "description" : "Request schema for constructing a query from a table.\n\n Query components:\n - filters: Filter conditions to apply\n - fields: Specific fields to select (omit for all fields)\n - aggregations: Aggregation functions (sum, count, avg, etc.). Use sort_order on the aggregation to order by it.\n - group_by: Fields to group by, with optional temporal granularity\n - order_by: Order by regular fields only. To order by an aggregation result, use sort_order on the aggregation instead.\n - limit: Maximum rows to return",+ "allOf" : [ {+ "type" : "object",+ "properties" : {+ "aggregations" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.aggregation"+ }+ }, {+ "type" : "null"+ } ]+ },+ "fields" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"+ }+ }, {+ "type" : "null"+ } ]+ },+ "filters" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"+ }+ }, {+ "type" : "null"+ } ]+ },+ "group_by" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"+ }+ }, {+ "type" : "null"+ } ]+ },+ "limit" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ },+ "order_by" : {+ "description" : "Order by regular fields only. To order by aggregation results, use sort_order on the aggregation.",+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"+ }+ }, {+ "type" : "null"+ } ]+ },+ "table_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "table_id" ]+ }, {+ "type" : "object",+ "properties" : { }+ } ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.entity-type" : {+ "description" : "The type of queryable entity.",+ "type" : "string",+ "enum" : [ "table", "metric" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.execute-query-request" : {+ "description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",+ "type" : "object",+ "properties" : {+ "query" : {+ "type" : "string",+ "minLength" : 1+ }+ },+ "required" : [ "query" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.field" : {+ "description" : "A field from a table or metric. The field_id format is '<prefix><entity-id>-<field-index>' where prefix indicates the source (t=table, c=metric) and index is the position in the entity's fields.",+ "type" : "object",+ "properties" : {+ "database_type" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "field_id" : {+ "type" : "string"+ },+ "field_values" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : { }+ }, {+ "type" : "null"+ } ]+ },+ "name" : {+ "type" : "string"+ },+ "semantic_type" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "type" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-type"+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "field_id", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.field-type" : {+ "description" : "A data type for a field derived from Metabase's type hierarchy.",+ "type" : "string",+ "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.field-values" : {+ "description" : "Statistics and sample values for a specific field.",+ "type" : "object",+ "properties" : {+ "field_id" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "statistics" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.statistics"+ }, {+ "type" : "null"+ } ]+ },+ "values" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : { }+ }, {+ "type" : "null"+ } ]+ }+ }+ },+ "metabase-enterprise.metabot-v3.agent-api.api.metric" : {+ "description" : "A metric with its queryable dimensions and segments. The default_time_dimension_field_id is the field_id of the recommended time dimension for temporal breakouts.",+ "type" : "object",+ "properties" : {+ "default_time_dimension_field_id" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ },+ "queryable_dimensions" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"+ }+ }, {+ "type" : "null"+ } ]+ },+ "segments" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.segment"+ }+ }, {+ "type" : "null"+ } ]+ },+ "type" : {+ "const" : "metric"+ },+ "verified" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "type", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.metric-summary" : {+ "description" : "Summary of a metric associated with a table. Includes the field_id of the default time dimension for temporal breakouts.",+ "type" : "object",+ "properties" : {+ "default_time_dimension_field_id" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ },+ "type" : {+ "const" : "metric"+ }+ },+ "required" : [ "id", "type", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.related-table" : {+ "description" : "A table related to the queried entity via foreign key. The related_by field indicates the FK field name.",+ "type" : "object",+ "properties" : {+ "database_engine" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ },+ "database_id" : {+ "oneOf" : [ {+ "type" : "integer"+ }, {+ "type" : "null"+ } ]+ },+ "related_by" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "display_name" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "type" : {+ "const" : "table"+ },+ "fields" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"+ }+ }, {+ "type" : "null"+ } ]+ },+ "database_schema" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "type", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.search-response" : {+ "description" : "Search results containing tables and metrics matching the query.",+ "type" : "object",+ "properties" : {+ "data" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.search-result-item"+ }+ },+ "total_count" : {+ "type" : "integer"+ }+ },+ "required" : [ "data", "total_count" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.search-result-item" : {+ "description" : "A table or metric returned from search.",+ "type" : "object",+ "properties" : {+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ },+ "verified" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ },+ "database_id" : {+ "oneOf" : [ {+ "type" : "integer"+ }, {+ "type" : "null"+ } ]+ },+ "updated_at" : {+ "oneOf" : [ { }, {+ "type" : "null"+ } ]+ },+ "display_name" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "type" : {+ "type" : "string",+ "enum" : [ "table", "metric" ]+ },+ "database_schema" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "created_at" : {+ "oneOf" : [ { }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "type", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.segment" : {+ "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",+ "type" : "object",+ "properties" : {+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "display_name" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ }+ },+ "required" : [ "id", "name" ]+ },+ "metabase-enterprise.metabot-v3.agent-api.api.statistics" : {+ "description" : "Statistical summary of a field's values computed during database sync. Includes counts, percentages, numeric summaries (min/max/avg/quartiles/sd), and date ranges.",+ "type" : "object",+ "properties" : {+ "min" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "percent_url" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "average_length" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "earliest" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "q1" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "max" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "distinct_count" : {+ "oneOf" : [ {+ "type" : "integer"+ }, {+ "type" : "null"+ } ]+ },+ "percent_state" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "percent_null" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "avg" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "sd" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "percent_email" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "latest" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "q3" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ },+ "percent_json" : {+ "oneOf" : [ {+ "type" : "number"+ }, {+ "type" : "null"+ } ]+ }+ }+ },+ "metabase-enterprise.metabot-v3.agent-api.api.table" : {+ "description" : "Full details of a table including its fields, related tables, metrics, and segments.",+ "type" : "object",+ "properties" : {+ "database_engine" : {+ "type" : "string"+ },+ "id" : {+ "type" : "integer"+ },+ "name" : {+ "type" : "string"+ },+ "database_id" : {+ "type" : "integer"+ },+ "related_tables" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.related-table"+ }+ }, {+ "type" : "null"+ } ]+ },+ "display_name" : {+ "type" : "string"+ },+ "segments" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.segment"+ }+ }, {+ "type" : "null"+ } ]+ },+ "type" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.entity-type"+ },+ "fields" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"+ }+ },+ "database_schema" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "metrics" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.metric-summary"+ }+ }, {+ "type" : "null"+ } ]+ },+ "description" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]+ },"metabase-enterprise.metabot-v3.client.schema.message" : {"type" : "object","properties" : {@@ -2432,7 +3109,7 @@} ]},"metabase-enterprise.metabot-v3.tools.api.field-aggregation" : {- "description" : "Aggregation using a field and function.",+ "description" : "Aggregation using a field and function.\n\n - field_id: Required. For 'count', any valid field_id can be provided (the value is ignored since count operates on rows).\n - function: The aggregation function to apply.\n - sort_order: Optional. Use this to order results by this aggregation ('asc' or 'desc').\n This is the correct way to sort by aggregation results - do NOT use order_by for aggregations.","allOf" : [ {"type" : "object","properties" : {@@ -3629,6 +4306,20 @@"properties" : { }} ]},+ "metabase-enterprise.metabot-v3.tools.api.order-by" : {+ "description" : "Order by item specifying a field and sort direction.",+ "type" : "object",+ "properties" : {+ "direction" : {+ "type" : "string",+ "enum" : [ "asc", "desc" ]+ },+ "field" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"+ }+ },+ "required" : [ "field", "direction" ]+ },"metabase-enterprise.metabot-v3.tools.api.proportion" : {"type" : "number"},@@ -3690,17 +4381,7 @@"oneOf" : [ {"type" : "array","items" : {- "type" : "object",- "properties" : {- "direction" : {- "type" : "string",- "enum" : [ "asc", "desc" ]- },- "field" : {- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"- }- },- "required" : [ "field", "direction" ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"}}, {"type" : "null"@@ -3807,17 +4488,7 @@"oneOf" : [ {"type" : "array","items" : {- "type" : "object",- "properties" : {- "direction" : {- "type" : "string",- "enum" : [ "asc", "desc" ]- },- "field" : {- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"- }- },- "required" : [ "field", "direction" ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"}}, {"type" : "null"@@ -13057,14 +13728,248 @@} ],"responses" : {"2XX" : {- "description" : "Successful response",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema.action"- }- }- }+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema.action"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/action" ]+ },+ "delete" : {+ "summary" : "DELETE /api/action/{action-id}",+ "description" : "Delete an Action.",+ "parameters" : [ {+ "in" : "path",+ "name" : "action-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/action" ]+ }+ },+ "/api/action/{action-id}/execute" : {+ "get" : {+ "summary" : "GET /api/action/{action-id}/execute",+ "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",+ "parameters" : [ {+ "in" : "path",+ "name" : "action-id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "parameters",+ "required" : true,+ "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/action" ]+ }+ },+ "/api/action/{id}" : {+ "put" : {+ "summary" : "PUT /api/action/{id}",+ "description" : "Update an Action.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema.id"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema..action.for-update"+ }+ }+ }+ },+ "tags" : [ "/api/action" ]+ }+ },+ "/api/action/{id}/execute" : {+ "post" : {+ "summary" : "POST /api/action/{id}/execute",+ "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema.id"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "oneOf" : [ {+ "type" : "object",+ "properties" : {+ "parameters" : {+ "oneOf" : [ {+ "type" : "object",+ "additionalProperties" : { }+ }, {+ "type" : "null"+ } ]+ }+ }+ }, {+ "type" : "null"+ } ]+ }+ }+ }+ },+ "tags" : [ "/api/action" ]+ }+ },+ "/api/action/{id}/public_link" : {+ "post" : {+ "summary" : "POST /api/action/{id}/public_link",+ "description" : "Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If this\n Action has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema.id"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/action" ]+ },+ "delete" : {+ "summary" : "DELETE /api/action/{id}/public_link",+ "description" : "Delete the publicly-accessible link to this Dashboard.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "$ref" : "#/components/schemas/metabase.actions.schema.id"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/action" ]+ }+ },+ "/api/activity/most_recently_viewed_dashboard" : {+ "get" : {+ "summary" : "GET /api/activity/most_recently_viewed_dashboard",+ "description" : "Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboards\n in the last 24 hours.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/activity" ]+ }+ },+ "/api/activity/popular_items" : {+ "get" : {+ "summary" : "GET /api/activity/popular_items",+ "description" : "Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anything\n archived, deleted, etc it can usually still get 5. ",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response"},"4XX" : {"description" : "Client error response"@@ -13073,21 +13978,14 @@"description" : "Server error response"}},- "tags" : [ "/api/action" ]- },- "delete" : {- "summary" : "DELETE /api/action/{action-id}",- "description" : "Delete an Action.",- "parameters" : [ {- "in" : "path",- "name" : "action-id",- "required" : true,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- } ],+ "tags" : [ "/api/activity" ]+ }+ },+ "/api/activity/recent_views" : {+ "get" : {+ "summary" : "GET /api/activity/recent_views",+ "description" : "Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing most\n recently. Return a maximum of 20 model of each, if they've looked at at least 20.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -13099,30 +13997,37 @@"description" : "Server error response"}},- "tags" : [ "/api/action" ]+ "deprecated" : true,+ "tags" : [ "/api/activity" ]}},- "/api/action/{action-id}/execute" : {+ "/api/activity/recents" : {"get" : {- "summary" : "GET /api/action/{action-id}/execute",- "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",+ "summary" : "GET /api/activity/recents",+ "description" : "Get a list of recent items the current user has been viewing most recently under the `:recents` key.\n Allows for filtering by context: views or selections","parameters" : [ {- "in" : "path",- "name" : "action-id",+ "in" : "query",+ "name" : "context","required" : true,"schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."+ "type" : "array",+ "items" : {+ "type" : "string",+ "enum" : [ "selections", "views" ]+ }+ }}, {"in" : "query",- "name" : "parameters",+ "name" : "include_metadata","required" : true,"schema" : {- "type" : "string"- },- "description" : "value must be a valid JSON string."+ "default" : false,+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }} ],"responses" : {"2XX" : {@@ -13135,21 +14040,12 @@"description" : "Server error response"}},- "tags" : [ "/api/action" ]- }- },- "/api/action/{id}" : {- "put" : {- "summary" : "PUT /api/action/{id}",- "description" : "Update an Action.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema.id"- }- } ],+ "tags" : [ "/api/activity" ]+ },+ "post" : {+ "summary" : "POST /api/activity/recents",+ "description" : "Adds a model to the list of recently selected items.",+ "parameters" : [ ],"responses" : {"2XX" : {"description" : "Successful response"@@ -13165,29 +14061,45 @@"content" : {"application/json" : {"schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema..action.for-update"+ "type" : "object",+ "properties" : {+ "context" : {+ "type" : "string",+ "enum" : [ "selection" ]+ },+ "model" : {+ "type" : "string",+ "enum" : [ "card", "dataset", "metric", "dashboard", "table", "collection", "document" ]+ },+ "model_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }+ },+ "required" : [ "model", "model_id", "context" ]}}}},- "tags" : [ "/api/action" ]+ "tags" : [ "/api/activity" ]}},- "/api/action/{id}/execute" : {+ "/api/agent/v1/construct-query" : {"post" : {- "summary" : "POST /api/action/{id}/execute",- "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema.id"- }- } ],+ "summary" : "POST /api/agent/v1/construct-query",+ "description" : "Construct an MBQL query from a table or metric.\n\n Returns a base64-encoded MBQL query that can be used with the query API.\n\n For tables, supports: filters, fields, aggregations, group_by, order_by, limit.\n For metrics, supports: filters, group_by (aggregation is defined by the metric).",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-response"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13200,43 +14112,29 @@"content" : {"application/json" : {"schema" : {- "oneOf" : [ {- "type" : "object",- "properties" : {- "parameters" : {- "oneOf" : [ {- "type" : "object",- "additionalProperties" : { }- }, {- "type" : "null"- } ]- }- }- }, {- "type" : "null"- } ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-request"}}}},- "tags" : [ "/api/action" ]+ "tags" : [ "/api/agent" ]}},- "/api/action/{id}/public_link" : {+ "/api/agent/v1/execute" : {"post" : {- "summary" : "POST /api/action/{id}/public_link",- "description" : "Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If this\n Action has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",- "parameters" : [ {- "in" : "path",- "name" : "id",- "required" : true,- "schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema.id"- }- } ],+ "summary" : "POST /api/agent/v1/execute",+ "description" : "Execute an MBQL query and return results.\n\n Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it,\n returning results with column metadata.\n\n Response format:\n - On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}\n - On failure: {:status :failed :error \"message\" ...}\n\n Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).",+ "parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13245,22 +14143,86 @@"description" : "Server error response"}},- "tags" : [ "/api/action" ]- },- "delete" : {- "summary" : "DELETE /api/action/{id}/public_link",- "description" : "Delete the publicly-accessible link to this Dashboard.",+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.execute-query-request"+ }+ }+ }+ },+ "tags" : [ "/api/agent" ]+ }+ },+ "/api/agent/v1/metric/{id}" : {+ "get" : {+ "summary" : "GET /api/agent/v1/metric/{id}",+ "description" : "Get details for a metric by ID.","parameters" : [ {"in" : "path","name" : "id","required" : true,"schema" : {- "$ref" : "#/components/schemas/metabase.actions.schema.id"+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "with-default-temporal-breakout",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "with-field-values",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "with-queryable-dimensions",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "with-segments",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}} ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.metric"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13268,18 +14230,42 @@"5XX" : {"description" : "Server error response"}- },- "tags" : [ "/api/action" ]- }- },- "/api/activity/most_recently_viewed_dashboard" : {- "get" : {- "summary" : "GET /api/activity/most_recently_viewed_dashboard",- "description" : "Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboards\n in the last 24 hours.",- "parameters" : [ ],+ },+ "tags" : [ "/api/agent" ]+ }+ },+ "/api/agent/v1/metric/{id}/field/{field-id}/values" : {+ "get" : {+ "summary" : "GET /api/agent/v1/metric/{id}/field/{field-id}/values",+ "description" : "Get statistics and sample values for a metric field.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "path",+ "name" : "field-id",+ "required" : true,+ "schema" : {+ "type" : "string",+ "minLength" : 1+ }+ } ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-values"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13288,17 +14274,30 @@"description" : "Server error response"}},- "tags" : [ "/api/activity" ]+ "tags" : [ "/api/agent" ]}},- "/api/activity/popular_items" : {+ "/api/agent/v1/ping" : {"get" : {- "summary" : "GET /api/activity/popular_items",- "description" : "Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anything\n archived, deleted, etc it can usually still get 5. ",+ "summary" : "GET /api/agent/v1/ping",+ "description" : "Health check endpoint for the Agent API.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "message" : {+ "type" : "string"+ }+ },+ "required" : [ "message" ]+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13307,17 +14306,24 @@"description" : "Server error response"}},- "tags" : [ "/api/activity" ]+ "tags" : [ "/api/agent" ]}},- "/api/activity/recent_views" : {- "get" : {- "summary" : "GET /api/activity/recent_views",- "description" : "Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing most\n recently. Return a maximum of 20 model of each, if they've looked at at least 20.",+ "/api/agent/v1/search" : {+ "post" : {+ "summary" : "POST /api/agent/v1/search",+ "description" : "Search for tables and metrics.\n\n Supports both term-based and semantic search queries. Results are ranked using\n Reciprocal Rank Fusion when both query types are provided.","parameters" : [ ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.search-response"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13326,58 +14332,132 @@"description" : "Server error response"}},- "deprecated" : true,- "tags" : [ "/api/activity" ]+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "semantic_queries" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "type" : "string",+ "minLength" : 1+ }+ }, {+ "type" : "null"+ } ]+ },+ "term_queries" : {+ "oneOf" : [ {+ "type" : "array",+ "items" : {+ "type" : "string",+ "minLength" : 1+ }+ }, {+ "type" : "null"+ } ]+ }+ }+ }+ }+ }+ },+ "tags" : [ "/api/agent" ]}},- "/api/activity/recents" : {+ "/api/agent/v1/table/{id}" : {"get" : {- "summary" : "GET /api/activity/recents",- "description" : "Get a list of recent items the current user has been viewing most recently under the `:recents` key.\n Allows for filtering by context: views or selections",+ "summary" : "GET /api/agent/v1/table/{id}",+ "description" : "Get details for a table by ID.","parameters" : [ {- "in" : "query",- "name" : "context",+ "in" : "path",+ "name" : "id","required" : true,"schema" : {- "type" : "array",- "items" : {- "type" : "string",- "enum" : [ "selections", "views" ]- }+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "with-field-values",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}}, {"in" : "query",- "name" : "include_metadata",- "required" : true,+ "name" : "with-fields",+ "required" : false,"schema" : {- "default" : false,"oneOf" : [ {"type" : "boolean"}, {"type" : "null"} ]}- } ],- "responses" : {- "2XX" : {- "description" : "Successful response"- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"+ }, {+ "in" : "query",+ "name" : "with-related-tables",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]}- },- "tags" : [ "/api/activity" ]- },- "post" : {- "summary" : "POST /api/activity/recents",- "description" : "Adds a model to the list of recently selected items.",- "parameters" : [ ],+ }, {+ "in" : "query",+ "name" : "with-metrics",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "with-measures",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "with-segments",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ } ],"responses" : {"2XX" : {- "description" : "Successful response"+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.table"+ }+ }+ }},"4XX" : {"description" : "Client error response"@@ -13386,52 +14466,38 @@"description" : "Server error response"}},- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "context" : {- "type" : "string",- "enum" : [ "selection" ]- },- "model" : {- "type" : "string",- "enum" : [ "card", "dataset", "metric", "dashboard", "table", "collection", "document" ]- },- "model_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }- },- "required" : [ "model", "model_id", "context" ]- }- }- }- },- "tags" : [ "/api/activity" ]+ "tags" : [ "/api/agent" ]}},- "/api/agent/v1/ping" : {+ "/api/agent/v1/table/{id}/field/{field-id}/values" : {"get" : {- "summary" : "GET /api/agent/v1/ping",- "description" : "Health check endpoint for the Agent API.",- "parameters" : [ ],+ "summary" : "GET /api/agent/v1/table/{id}/field/{field-id}/values",+ "description" : "Get statistics and sample values for a table field.",+ "parameters" : [ {+ "in" : "path",+ "name" : "id",+ "required" : true,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "path",+ "name" : "field-id",+ "required" : true,+ "schema" : {+ "type" : "string",+ "minLength" : 1+ }+ } ],"responses" : {"2XX" : {"description" : "Successful response","content" : {"application/json" : {"schema" : {- "type" : "object",- "properties" : {- "message" : {- "type" : "string"- }- },- "required" : [ "message" ]+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-values"}}}@@ -14590,7 +15656,7 @@"/api/cache/" : {"get" : {"summary" : "GET /api/cache/",- "description" : "Return cache configuration.",+ "description" : "Return cache configuration. Supports pagination via `limit` and `offset` query parameters,\n and sorting via `sort_column` and `sort_direction`.","parameters" : [ {"in" : "query","name" : "model",@@ -14632,6 +15698,24 @@} ]},"description" : "Model id to get configuration for."+ }, {+ "in" : "query",+ "name" : "sort_column",+ "required" : true,+ "schema" : {+ "default" : "name",+ "type" : "string",+ "enum" : [ "name", "policy", "collection" ]+ }+ }, {+ "in" : "query",+ "name" : "sort_direction",+ "required" : true,+ "schema" : {+ "default" : "asc",+ "type" : "string",+ "enum" : [ "asc", "desc" ]+ }} ],"responses" : {"2XX" : {@@ -21802,7 +22886,7 @@"required" : true,"schema" : {"type" : "string",- "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution" ]+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution", "transforms" ]}} ],"responses" : {