使用 API 创建数据探索器查询
本操作指南说明了如何使用 Discourse API 创建 数据探索器 查询。
所需用户级别：管理员
先决条件
在开始之前，请确保您已：
- 在您的站点上安装并启用了 数据探索器 插件
- 具有全局范围的 API 密钥，并与管理员用户相关联（参见 创建和配置 API 密钥）
创建查询需要全局 API 密钥。仅具有“运行查询”范围的细粒度密钥只允许运行现有查询，而不能创建新查询。
创建查询
要创建新的数据探索器查询，请向 /admin/plugins/explorer/queries 发送一个 POST 请求。
参数
| 参数 | 是否必需 | 描述 |
|---|---|---|
query[name] |
是 | 查询的名称 |
query[sql] |
是 | 要执行的 SQL 语句 |
query[description] |
否 | 关于查询功能的描述 |
query[group_ids] |
否 | 可以访问此查询的组 ID 数组 |
示例请求
curl -X POST "https://your-site.com/admin/plugins/explorer/queries" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: <username>" \
-F 'query[name]=User count query' \
-F 'query[sql]=SELECT COUNT(*) FROM users'
示例响应
{
"query": {
"id": 49,
"name": "User count query",
"description": null,
"username": "<username>",
"group_ids": [],
"last_run_at": "2025-03-13T18:41:44.226Z",
"user_id": 1,
"sql": "SELECT COUNT(*) FROM users",
"param_info": [],
"created_at": "2025-03-13T18:41:44.226Z",
"hidden": false
}
}
请注意响应中的 id 值——您需要它来运行查询。有关通过 API 运行查询的详细信息，请参阅 使用 Discourse API 运行数据探索器查询。