卡片
/api/card端点。
DELETE /api/card/:card-id/public_link
删除此卡片可公开访问的链接。
参数
card-id的值必须是一个大于零的整数。
DELETE /api/card/:id
硬删除卡片。要软删除，请使用PUT /api/card/:id。
参数
id的值必须是一个大于零的整数。
GET /api/card/
获取所有卡片。可以使用选项筛选参数f来更改返回的卡片集；默认为all，但其他选项还包括mine、bookmarked、database、table、using_model、using_metric、using_segment和archived。请参阅上面的相应实现函数以了解每个筛选选项的具体行为。:card_index。
参数
-
f可为空枚举类型，包括已存档、表格、using_model、收藏、using_segment、全部、mine、using_metric、数据库。 -
model_id可为空值，必须是一个大于零的整数。
GET /api/card/:card-id/params/:param-key/search/:query
获取ID为:param-key的参数的可能值，这些值包含:query。
;; fetch values for Card 1 parameter 'abc' that contain 'Orange';
GET /api/card/1/params/abc/search/Orange
目前限制为前1000个结果。
参数
-
card-id的值必须是一个大于零的整数。 -
param-key的值必须是非空字符串。 -
query的值必须是非空字符串。
GET /api/card/:card-id/params/:param-key/values
获取ID为:param-key的参数的可能值。
;; fetch values for Card 1 parameter 'abc' that are possible
GET /api/card/1/params/abc/values.
参数
-
card-id的值必须是一个大于零的整数。 -
param-key的值必须是非空字符串。
GET /api/card/:id
通过ID获取Card。
参数
-
id的值必须是一个大于零的整数。 -
ignore_view可为空布尔值。 -
context可为空枚举类型，包括:collection。
GET /api/card/:id/query_metadata
获取卡片所需的所有查询元数据。
参数
id的值必须是一个大于零的整数。
GET /api/card/:id/series
获取与ID为card_id的卡片兼容的系列列表。
last_cursor的值是上一页最后一张卡片的ID，用于获取下一页。query用于按名称搜索卡片。exclude_ids用于过滤出卡片ID列表。
参数
-
id整数。 -
last_cursor可为空值，必须是一个大于零的整数。 -
query可为空值，必须是非空字符串。 -
exclude_ids可为空函数。
GET /api/card/:id/timelines
获取具有ID的卡片的时序。查找卡片所在的集合并使用该集合。
参数
-
id的值必须是一个大于零的整数。 -
include可为空，必须等于events。 -
start可空值必须是一个有效的日期字符串。 -
end可空值必须是一个有效的日期字符串。
GET /api/card/embeddable
获取一组enable_embedding为true的Cards列表。可以使用嵌入端点和签名JWT来嵌入这些cards。
GET /api/card/public
获取具有公共UUIDs的Cards列表。如果启用公共共享，这些cards将是公开可访问的。
POST /api/card/
创建一个新的Card。Card的type可以是question、metric或model。
参数
-
visualization_settings值必须是一个映射。 -
parameters可空序列的参数必须是一个具有:id和:type键的映射。 -
description可空值必须是非空字符串。 -
collection_position可空值必须是一个大于零的整数。 -
result_metadata可空值必须是一个有效的结果列元数据映射的数组。 -
collection_id可空值必须是一个大于零的整数。 -
name值必须是非空字符串。 -
type可空枚举值：:question, :metric, :model。 -
cache_ttl可空值必须是一个大于零的整数。 -
dataset_query值必须是一个映射。 -
parameter_mappings可空序列的参数映射必须是一个具有:parameter_id和:target键的映射。 -
display值必须是非空字符串。
POST /api/card/:card-id/persist
将模型（卡片）标记为已持久化。运行查询并将其保存到支持卡片的数据库中，并在此处替换模型查询。
参数
card-id的值必须是一个大于零的整数。
POST /api/card/:card-id/public_link
为该Card生成公开访问链接。返回用于公开链接的UUID。（如果此Card已经共享，则返回现有的公开链接而不是创建一个新的链接。）必须启用公共共享。
参数
card-id的值必须是一个大于零的整数。
POST /api/card/:card-id/query
运行与Card关联的查询。
参数
-
card-id的值必须是一个大于零的整数。 -
参数 -
ignore_cache可空布尔值。 -
dashboard_id可空值必须是一个大于零的整数。 -
collection_preview可空布尔值。
POST /api/card/:card-id/query/:export-format
运行与Card关联的查询，并以指定格式返回其结果文件。
parameters 应作为查询参数传递，编码为序列化的JSON字符串（这是因为此端点通常用于为使用HTML form操作的“下载结果”按钮提供动力）。
参数
-
card-id的值必须是一个大于零的整数。 -
export-format枚举值：csv, api, xlsx, json。 -
parameters可空值必须是一个有效的JSON字符串。 -
format_rows可空布尔值。
POST /api/card/:card-id/refresh
刷新持久化模型缓存card-id。
参数
card-id的值必须是一个大于零的整数。
POST /api/card/:card-id/unpersist
取消持久化此模型。删除支持该模型的持久化表，之后所有查询将使用卡片查询，而不是查询的保存版本。
参数
card-id的值必须是一个大于零的整数。
POST /api/card/:id/copy
复制一张 卡片，新名称为‘名称的副本’。
参数
id可空值必须是一个大于零的整数。
POST /api/card/collections
卡片集合的大批量更新端点。将一组具有 card_ids 的 Cards 移动到具有 collection_id 的 集合 中，或者通过传递 null collection_id 从任何集合中删除它们。
参数
-
card_ids值的序列必须是一个大于零的整数。 -
collection_id可空值必须是一个大于零的整数。
POST /api/card/from-csv
创建一个表和一个模型，其中包含附带的 CSV 文件中的值。如果成功，则返回模型 ID。
参数
raw-params
POST /api/card/pivot/:card-id/query
运行与Card关联的查询。
参数
-
card-id的值必须是一个大于零的整数。 -
参数 -
ignore_cache可空布尔值。
PUT /api/card/:id
更新一张 卡片。
参数
-
collection_preview可空布尔值。 -
visualization_settings可空值必须是一个映射。 -
parameters可空序列的参数必须是一个具有:id和:type键的映射。 -
description可空字符串。 -
archived可空布尔值。 -
collection_position可空值必须是一个大于零的整数。 -
result_metadata可空值必须是一个有效的结果列元数据映射的数组。 -
enable_embedding可空布尔值。 -
collection_id可空值必须是一个大于零的整数。 -
card-updates -
name可空值必须是一个非空字符串。 -
type可空枚举值：:question, :metric, :model。 -
embedding_params可空值必须是一个有效的嵌入参数映射。 -
cache_ttl可空值必须是一个大于零的整数。 -
dataset_query可空值必须是一个映射。 -
id的值必须是一个大于零的整数。 -
display可空值必须是一个非空字符串。
阅读其他 Metabase 版本 的文档。