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

github-automation-metabaseb0d28fcfa4cb
diff --git a/docs/api.json b/docs/api.json
index 78cd14cae5f..fbd3287c41c 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1147,1152 +1147,935 @@
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
} ]
},
- "metabase-enterprise.data-studio.api.table.bulk-table-info" : {
- "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_published" : {
- "type" : "boolean"
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
- },
- "metabase-enterprise.data-studio.api.table.bulk-table-selection-info" : {
- "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
- "type" : "object",
- "properties" : {
- "published_downstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
+ "metabase-enterprise.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
}
},
- "selected_table" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
- }, {
- "type" : "null"
- } ]
- },
- "unpublished_upstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
- }
- }
- },
- "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
- },
- "metabase-enterprise.data-studio.api.table.data-authorities" : {
- "type" : "string",
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
- },
- "metabase-enterprise.data-studio.api.table.data-layers" : {
- "type" : "string",
- "enum" : [ "copper", "bronze", "gold", "silver" ]
+ "required" : [ "metric_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
},
- "metabase-enterprise.data-studio.api.table.data-sources" : {
- "type" : "string",
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ "metabase-enterprise.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.agent-api.api.construct-query-table-request"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-metric-request"
+ } ]
},
- "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
- "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
+ "metabase-enterprise.agent-api.api.construct-query-response" : {
+ "description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",
"type" : "object",
"properties" : {
- "target_collection" : {
- "oneOf" : [ {
- "description" : "value must be an instance of :model/Collection"
- }, {
- "type" : "null"
- } ]
+ "query" : {
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "target_collection" ]
+ "required" : [ "query" ]
},
- "metabase-enterprise.data-studio.api.table.table-selectors" : {
- "type" : "object",
- "properties" : {
- "database_ids" : {
- "type" : "array",
- "items" : {
+ "metabase-enterprise.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
}
},
- "schema_ids" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }
- }
+ "required" : [ "table_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
},
- "metabase-enterprise.dependencies.api.base-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : { }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
+ "metabase-enterprise.agent-api.api.entity-type" : {
+ "description" : "The type of queryable entity.",
+ "type" : "string",
+ "enum" : [ "table", "metric" ]
},
- "metabase-enterprise.dependencies.api.broken-cards-response" : {
+ "metabase-enterprise.agent-api.api.execute-query-request" : {
+ "description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",
"type" : "object",
"properties" : {
- "bad_cards" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.card"
- }
- },
- "bad_transforms" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform"
- }
- },
- "success" : {
- "type" : "boolean"
+ "query" : {
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "success" ]
+ "required" : [ "query" ]
},
- "metabase-enterprise.dependencies.api.card-body" : {
- "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
+ "metabase-enterprise.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" : {
- "dataset_query" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- }, {
- "type" : "null"
- } ]
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
+ "database_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "database_id" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "document_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
- }, {
- "type" : "null"
- } ]
+ "field_id" : {
+ "type" : "string"
},
- "result_metadata" : {
+ "field_values" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ "type" : "array",
+ "items" : { }
}, {
"type" : "null"
} ]
},
- "collection_id" : {
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
"type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-type"
}, {
"type" : "null"
} ]
- },
- "parameters" : {
+ }
+ },
+ "required" : [ "field_id", "name" ]
+ },
+ "metabase-enterprise.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.agent-api.api.field-values" : {
+ "description" : "Statistics and sample values for a specific field.",
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "statistics" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.statistics"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "values" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ "type" : "array",
+ "items" : { }
}, {
"type" : "null"
} ]
}
}
},
- "metabase-enterprise.dependencies.api.card-entity" : {
+ "metabase-enterprise.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" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "dashboard" : { },
- "last-edit-info" : { },
- "view_count" : { },
- "collection" : { },
- "document" : { },
- "creator" : { },
- "name" : { },
- "database_id" : { },
- "document_id" : { },
- "result_metadata" : { },
- "query_type" : { },
- "collection_id" : { },
- "type" : { },
- "created_at" : { },
- "display" : { },
- "creator_id" : { },
- "description" : { },
- "dashboard_id" : { }
- }
- },
- "dependents_count" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "card"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.dashboard-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "last-edit-info" : { },
- "view_count" : { },
- "collection" : { },
- "moderation_reviews" : { },
- "creator" : { },
- "name" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator_id" : { },
- "description" : { }
- }
- },
- "dependents_count" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
"id" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "type" : {
- "const" : "dashboard"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.document-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "description" : { },
- "name" : { },
- "view_count" : { }
- }
+ "name" : {
+ "type" : "string"
},
- "dependents_count" : {
+ "queryable_dimensions" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ }
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "document"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.entity" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.table-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.snippet-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dashboard-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.document-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.sandbox-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.segment-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.measure-entity"
- } ]
- },
- "metabase-enterprise.dependencies.api.graph-response" : {
- "type" : "object",
- "properties" : {
- "edges" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "from_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
- },
- "from_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- },
- "to_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
- },
- "to_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }
- },
- "required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ]
- }
- },
- "nodes" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
- }
- }
- },
- "required" : [ "nodes", "edges" ]
- },
- "metabase-enterprise.dependencies.api.measure-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "name" : { },
- "table" : { },
- "table_id" : { }
- }
- },
- "dependents_count" : {
+ "segments" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
+ }
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
"type" : {
- "const" : "measure"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.sandbox-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "table" : { },
- "table_id" : { }
- }
+ "const" : "metric"
},
- "dependents_count" : {
+ "verified" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "sandbox"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ]
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.dependencies.api.segment-entity" : {
+ "metabase-enterprise.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" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "dashboard" : { },
- "last-edit-info" : { },
- "view_count" : { },
- "collection" : { },
- "document" : { },
- "creator" : { },
- "name" : { },
- "database_id" : { },
- "document_id" : { },
- "result_metadata" : { },
- "query_type" : { },
- "collection_id" : { },
- "type" : { },
- "created_at" : { },
- "display" : { },
- "creator_id" : { },
- "description" : { },
- "dashboard_id" : { }
- }
- },
- "dependents_count" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"id" : {
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
},
"type" : {
- "const" : "segment"
+ "const" : "metric"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ]
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.dependencies.api.snippet-entity" : {
+ "metabase-enterprise.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" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "name" : { }
- }
+ "database_engine" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "dependents_count" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "database_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
+ "related_by" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"type" : {
- "const" : "snippet"
+ "const" : "table"
+ },
+ "fields" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "type", "data", "dependents_count" ]
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.dependencies.api.table-entity" : {
+ "metabase-enterprise.agent-api.api.search-response" : {
+ "description" : "Search results containing tables and metrics matching the query.",
"type" : "object",
"properties" : {
"data" : {
- "type" : "object",
- "properties" : {
- "db" : { },
- "db_id" : { },
- "description" : { },
- "display_name" : { },
- "fields" : { },
- "name" : { },
- "schema" : { },
- "transform" : { }
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-result-item"
}
},
- "dependents_count" : {
+ "total_count" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total_count" ]
+ },
+ "metabase-enterprise.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" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
+ "database_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"type" : {
- "const" : "table"
+ "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", "data", "dependents_count" ]
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.dependencies.api.transform-body" : {
+ "metabase-enterprise.agent-api.api.segment" : {
+ "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",
"type" : "object",
"properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
- },
- "name" : {
- "type" : "string"
- },
- "source" : {
+ "description" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- },
- "type" : {
- "type" : "string"
- }
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "target" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
}
},
- "required" : [ "id" ]
+ "required" : [ "id", "name" ]
},
- "metabase-enterprise.dependencies.api.transform-entity" : {
+ "metabase-enterprise.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" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "creator" : { },
- "description" : { },
- "last_run" : { },
- "name" : { },
- "table" : { }
- }
+ "min" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "dependents_count" : {
+ "percent_url" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
+ "average_length" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "earliest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "transform"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.usages" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
- }
- },
- "metabase-enterprise.dependencies.dependency-types.dependency-types" : {
- "type" : "string",
- "enum" : [ "transform", "table", "snippet", "dashboard", "sandbox", "measure", "card", "document", "segment" ]
- },
- "metabase-enterprise.dependencies.dependency-types.entity-id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error" : {
- "description" : "Schema for an AnalysisFindingError record.",
- "type" : "object",
- "properties" : {
- "analyzed_entity_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "q1" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "analyzed_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ "max" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "error_detail" : {
+ "distinct_count" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "error_type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
+ "percent_state" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "percent_null" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "source_entity_id" : {
+ "avg" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "source_entity_type" : {
+ "sd" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.source-entity-type"
+ "type" : "number"
}, {
"type" : "null"
} ]
- }
- },
- "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
- }
+ "percent_email" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "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" : {
+ "latest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "q3" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "field_id" : {
+ "percent_json" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase-enterprise.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"
},
- "field_values" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "type" : "integer"
+ },
+ "related_tables" : {
"oneOf" : [ {
"type" : "array",
- "items" : { }
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.related-table"
+ }
}, {
"type" : "null"
} ]
},
- "name" : {
+ "display_name" : {
"type" : "string"
},
- "semantic_type" : {
+ "segments" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
+ }
}, {
"type" : "null"
} ]
},
"type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.entity-type"
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ }
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metrics" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric-summary"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-type"
+ "type" : "string"
}, {
"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" ]
+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
},
- "metabase-enterprise.metabot-v3.agent-api.api.field-values" : {
- "description" : "Statistics and sample values for a specific field.",
+ "metabase-enterprise.data-studio.api.table.bulk-table-info" : {
+ "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
"type" : "object",
"properties" : {
- "field_id" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_published" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
+ },
+ "metabase-enterprise.data-studio.api.table.bulk-table-selection-info" : {
+ "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "type" : "object",
+ "properties" : {
+ "published_downstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
+ }
},
- "statistics" : {
+ "selected_table" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.statistics"
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
}, {
"type" : "null"
} ]
},
- "values" : {
+ "unpublished_upstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
+ }
+ }
+ },
+ "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
+ },
+ "metabase-enterprise.data-studio.api.table.data-authorities" : {
+ "type" : "string",
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
+ },
+ "metabase-enterprise.data-studio.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "copper", "bronze", "gold", "silver" ]
+ },
+ "metabase-enterprise.data-studio.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
+ "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
+ "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
+ "type" : "object",
+ "properties" : {
+ "target_collection" : {
"oneOf" : [ {
- "type" : "array",
- "items" : { }
+ "description" : "value must be an instance of :model/Collection"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "target_collection" ]
},
- "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.",
+ "metabase-enterprise.data-studio.api.table.table-selectors" : {
"type" : "object",
"properties" : {
- "default_time_dimension_field_id" : {
- "oneOf" : [ {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ }
},
- "description" : {
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ }
+ },
+ "metabase-enterprise.dependencies.api.base-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
+ },
"id" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "name" : {
+ "type" : {
"type" : "string"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.broken-cards-response" : {
+ "type" : "object",
+ "properties" : {
+ "bad_cards" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card"
+ }
},
- "queryable_dimensions" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"
- }
- }, {
- "type" : "null"
- } ]
+ "bad_transforms" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform"
+ }
+ },
+ "success" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "success" ]
+ },
+ "metabase-enterprise.dependencies.api.broken-dependent-entity" : {
+ "description" : "Entity returned by /graph/broken endpoint - includes errors but no dependents_count.",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : { }
},
- "segments" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.segment"
- }
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
"type" : {
- "const" : "metric"
- },
- "verified" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
},
- "required" : [ "id", "type", "name" ]
+ "required" : [ "id", "type", "data" ]
},
- "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.",
+ "metabase-enterprise.dependencies.api.card-body" : {
+ "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
"type" : "object",
"properties" : {
- "default_time_dimension_field_id" : {
+ "dataset_query" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "parameter_mappings" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
},
"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"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
},
- "related_by" : {
+ "document_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}, {
"type" : "null"
} ]
},
- "display_name" : {
+ "result_metadata" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
}, {
"type" : "null"
} ]
},
- "type" : {
- "const" : "table"
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
},
- "fields" : {
+ "type" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"type" : "null"
} ]
},
- "database_schema" : {
+ "parameters" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
}, {
"type" : "null"
} ]
@@ -2303,300 +2086,541 @@
}, {
"type" : "null"
} ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "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.",
+ "metabase-enterprise.dependencies.api.card-entity" : {
"type" : "object",
"properties" : {
"data" : {
+ "type" : "object",
+ "properties" : {
+ "dashboard" : { },
+ "last-edit-info" : { },
+ "view_count" : { },
+ "collection" : { },
+ "document" : { },
+ "creator" : { },
+ "name" : { },
+ "database_id" : { },
+ "document_id" : { },
+ "result_metadata" : { },
+ "query_type" : { },
+ "collection_id" : { },
+ "type" : { },
+ "created_at" : { },
+ "display" : { },
+ "creator_id" : { },
+ "description" : { },
+ "dashboard_id" : { }
+ }
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.search-result-item"
- }
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "total_count" : {
- "type" : "integer"
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "card"
}
},
- "required" : [ "data", "total_count" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.metabot-v3.agent-api.api.search-result-item" : {
- "description" : "A table or metric returned from search.",
+ "metabase-enterprise.dependencies.api.dashboard-entity" : {
"type" : "object",
"properties" : {
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "verified" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "last-edit-info" : { },
+ "view_count" : { },
+ "collection" : { },
+ "moderation_reviews" : { },
+ "creator" : { },
+ "name" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator_id" : { },
+ "description" : { }
+ }
},
- "database_id" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "updated_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
"type" : {
- "type" : "string",
- "enum" : [ "table", "metric" ]
+ "const" : "dashboard"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.document-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
+ "description" : { },
+ "name" : { },
+ "view_count" : { }
+ }
},
- "database_schema" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "created_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "document"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.entity" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.table-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.snippet-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dashboard-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.document-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.sandbox-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.segment-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.measure-entity"
+ } ]
+ },
+ "metabase-enterprise.dependencies.api.graph-response" : {
+ "type" : "object",
+ "properties" : {
+ "edges" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "from_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
+ },
+ "from_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "to_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
+ },
+ "to_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ },
+ "required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ]
+ }
},
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "nodes" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ }
}
},
- "required" : [ "id", "type", "name" ]
+ "required" : [ "nodes", "edges" ]
},
- "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.",
+ "metabase-enterprise.dependencies.api.measure-entity" : {
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "description" : { },
+ "name" : { },
+ "table" : { },
+ "table_id" : { }
+ }
},
- "display_name" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
+ },
"id" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "name" : {
- "type" : "string"
+ "type" : {
+ "const" : "measure"
}
},
- "required" : [ "id", "name" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "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.",
+ "metabase-enterprise.dependencies.api.sandbox-entity" : {
"type" : "object",
"properties" : {
- "min" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "table" : { },
+ "table_id" : { }
+ }
},
- "percent_url" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "average_length" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "earliest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "q1" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "type" : {
+ "const" : "sandbox"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.segment-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "dashboard" : { },
+ "last-edit-info" : { },
+ "view_count" : { },
+ "collection" : { },
+ "document" : { },
+ "creator" : { },
+ "name" : { },
+ "database_id" : { },
+ "document_id" : { },
+ "result_metadata" : { },
+ "query_type" : { },
+ "collection_id" : { },
+ "type" : { },
+ "created_at" : { },
+ "display" : { },
+ "creator_id" : { },
+ "description" : { },
+ "dashboard_id" : { }
+ }
},
- "max" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "distinct_count" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "percent_state" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "percent_null" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "type" : {
+ "const" : "segment"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.snippet-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "description" : { },
+ "name" : { }
+ }
},
- "avg" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "sd" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "percent_email" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "latest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : {
+ "const" : "snippet"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.table-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "owner" : { },
+ "schema" : { },
+ "transform" : { },
+ "owner_email" : { },
+ "owner_user_id" : { },
+ "name" : { },
+ "display_name" : { },
+ "fields" : { },
+ "db" : { },
+ "db_id" : { },
+ "description" : { }
+ }
},
- "q3" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "number"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "percent_json" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "table"
}
- }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.metabot-v3.agent-api.api.table" : {
- "description" : "Full details of a table including its fields, related tables, metrics, and segments.",
+ "metabase-enterprise.dependencies.api.transform-body" : {
"type" : "object",
"properties" : {
- "database_engine" : {
- "type" : "string"
- },
"id" : {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
},
"name" : {
"type" : "string"
},
- "database_id" : {
- "type" : "integer"
- },
- "related_tables" : {
+ "source" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.related-table"
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ },
+ "type" : {
+ "type" : "string"
+ }
}
}, {
"type" : "null"
} ]
},
- "display_name" : {
- "type" : "string"
- },
- "segments" : {
+ "target" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.segment"
- }
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id" ]
+ },
+ "metabase-enterprise.dependencies.api.transform-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "creator" : { },
+ "description" : { },
+ "last_run" : { },
+ "name" : { },
+ "owner" : { },
+ "owner_email" : { },
+ "owner_user_id" : { },
+ "table" : { }
+ }
},
- "type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.entity-type"
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
},
- "fields" : {
+ "dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field"
- }
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "database_schema" : {
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "transform"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
+ },
+ "metabase-enterprise.dependencies.api.usages" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
+ }
+ },
+ "metabase-enterprise.dependencies.dependency-types.dependency-types" : {
+ "type" : "string",
+ "enum" : [ "transform", "table", "snippet", "dashboard", "sandbox", "measure", "card", "document", "segment" ]
+ },
+ "metabase-enterprise.dependencies.dependency-types.entity-id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error" : {
+ "description" : "Schema for an AnalysisFindingError record.",
+ "type" : "object",
+ "properties" : {
+ "analyzed_entity_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "analyzed_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "error_detail" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "metrics" : {
+ "error_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "source_entity_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.metric-summary"
- }
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "description" : {
+ "source_entity_type" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.validate.source-entity-type"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
+ "required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ]
},
"metabase-enterprise.metabot-v3.client.schema.message" : {
"type" : "object",
@@ -14096,7 +14120,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-response"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-response"
}
}
}
@@ -14112,7 +14136,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.construct-query-request"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-request"
}
}
}
@@ -14147,7 +14171,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.execute-query-request"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.execute-query-request"
}
}
}
@@ -14219,7 +14243,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.metric"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric"
}
}
}
@@ -14262,7 +14286,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-values"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
}
}
}
@@ -14320,7 +14344,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.search-response"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-response"
}
}
}
@@ -14454,7 +14478,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.table"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.table"
}
}
}
@@ -14497,7 +14521,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.agent-api.api.field-values"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
}
}
}
@@ -23789,10 +23813,10 @@
"tags" : [ "/api/ee/dependencies" ]
}
},
- "/api/ee/dependencies/graph/broken" : {
+ "/api/ee/dependencies/graph/breaking" : {
"get" : {
- "summary" : "GET /api/ee/dependencies/graph/broken",
- "description" : "Returns a list of entities that are causing errors in downstream dependents\n These are tables or cards that other entities depend on, where those dependents\n have validation errors traced back to this source entity.\n\n Accepts optional parameters for filtering:\n - `types`: List of source entity types - only `:card` or `:table` (default: both)\n - `card_types`: List of card types to include when filtering cards (e.g., `[:question :model :metric]`)\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include_personal_collections`: Controls whether items in personal collections are included (default: false)\n - `sort_column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort_direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of breaking source entities\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
+ "summary" : "GET /api/ee/dependencies/graph/breaking",
+ "description" : "Returns a list of entities that are breaking other entities (sources of errors).\n These are tables or cards that other entities depend on, where those dependents\n have validation errors traced back to this source entity.\n\n Accepts optional parameters for filtering:\n - `types`: List of source entity types - only `:card` or `:table` (default: both)\n - `card_types`: List of card types to include when filtering cards (e.g., `[:question :model :metric]`)\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include_personal_collections`: Controls whether items in personal collections are included (default: false)\n - `sort_column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort_direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of breaking source entities\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
"parameters" : [ {
"in" : "query",
"name" : "types",
@@ -23850,7 +23874,124 @@
"required" : false,
"schema" : {
"type" : "string",
- "enum" : [ "dependents-with-errors", "dependents-errors", "name", "location" ]
+ "enum" : [ "dependents-with-errors", "dependents-errors", "name", "location" ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_direction",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "desc", "asc" ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ }
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "total" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "data", "total", "offset", "limit" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/dependencies" ]
+ }
+ },
+ "/api/ee/dependencies/graph/broken" : {
+ "get" : {
+ "summary" : "GET /api/ee/dependencies/graph/broken",
+ "description" : "Returns the broken dependents for a specific source entity.\n These are entities that have validation errors traced back to the specified source.\n\n Required parameters:\n - `id`: The ID of the source entity\n - `type`: The type of the source entity (card, table)\n\n Optional parameters:\n - `dependent_types`: Dependency types to filter by. Can be single value or array.\n - `dependent_card_types`: Card types to filter by when dependent_types includes :card.\n - `include_personal_collections`: Include items in personal collections (default: false)\n - `sort_column`: Column to sort by - name, location, or view-count (default: name)\n - `sort_direction`: Sort direction - asc or desc (default: asc)",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "type",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent_types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent_card_types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "type" : "string",
+ "enum" : [ "question", "metric", "model" ]
+ }, {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "question", "metric", "model" ]
+ }
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_personal_collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_column",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "name", "view-count", "location" ]
}
}, {
"in" : "query",
@@ -23867,29 +24008,10 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
- }
- },
- "limit" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "offset" : {
- "type" : "integer",
- "minimum" : 0
- },
- "total" : {
- "type" : "integer",
- "minimum" : 0
- }
- },
- "required" : [ "data", "total", "offset", "limit" ]
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-dependent-entity"
+ }
}
}
}
@@ -29961,7 +30083,8 @@
"type" : "object",
"additionalProperties" : {
"type" : "integer"
- }
+ },
+ "minProperties" : 1
}
},
"required" : [ "code", "source_tables" ]
@@ -31694,6 +31817,343 @@
"tags" : [ "/api/ldap" ]
}
},
+ "/api/llm/extract-tables" : {
+ "post" : {
+ "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.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "type" : "object",
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "columns" ]
+ }
+ }
+ },
+ "required" : [ "tables" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "database_id", "sql" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/llm" ]
+ }
+ },
+ "/api/llm/generate-sql" : {
+ "post" : {
+ "summary" : "POST /api/llm/generate-sql",
+ "description" : "Generate SQL from a natural language prompt.\n\n Requires:\n - LLM to be configured (Anthropic API key set in admin settings)\n - At least one table reference (explicit @mention or implicit from source_sql)\n - A database_id parameter\n\n Returns generated SQL and the list of tables used for context.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "referenced_entities" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "type" : "object",
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "model", "id", "name", "columns" ]
+ }
+ },
+ "sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "sql", "referenced_entities" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "prompt" : {
+ "type" : "string"
+ },
+ "referenced_entities" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "model" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "model", "id" ]
+ }
+ },
+ "source_sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "prompt", "database_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/llm" ]
+ }
+ },
+ "/api/llm/list-models" : {
+ "get" : {
+ "summary" : "GET /api/llm/list-models",
+ "description" : "List available LLM models from the configured provider.\n\n Requires LLM to be configured (Anthropic API key set in admin settings).",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "models" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ }
+ }
+ },
+ "required" : [ "models" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/llm" ]
+ }
+ },
"/api/logger/adjustment" : {
"post" : {
"summary" : "POST /api/logger/adjustment",