docs: 更新文档以反映从域名到站点的术语变更
- 将“域名筛选”统一更新为“站点筛选”或“多站点管理” - 更新管理后台API文档,明确支持通过siteId参数筛选数据 - 在站点隔离配置文档中新增管理后台API使用说明 - 更新数据统计文档,将按域名分类改为按站点分类 - 修正相关API参数说明,从domain参数改为siteId参数
This commit is contained in:
@@ -30,7 +30,7 @@ GET /admin/comments/list
|
||||
说明:
|
||||
|
||||
- 当前实现中每页固定大小为 `10`,暂不支持 `pageSize` 或状态过滤;
|
||||
- 当提供 `domain` 参数时,会匹配该域名下的评论,例如 `https://example.com/...`、`http://example.com/...`。
|
||||
- 当提供 `siteId` 参数且不为 `default` 时,仅返回该站点下的评论。
|
||||
|
||||
**成功响应**
|
||||
|
||||
|
||||
@@ -14,12 +14,23 @@ Authorization: Bearer <token>
|
||||
GET /admin/comments/export
|
||||
```
|
||||
|
||||
导出所有评论数据,返回格式为 JSON,字段与数据库结构一致。
|
||||
导出评论数据,返回格式为 JSON,字段与数据库结构一致。
|
||||
|
||||
- 方法:`GET`
|
||||
- 路径:`/admin/comments/export`
|
||||
- 鉴权:需要(Bearer Token)
|
||||
|
||||
**查询参数**
|
||||
|
||||
| 名称 | 位置 | 类型 | 必填 | 说明 |
|
||||
| -------- | ----- | ------ | ---- | ------------------------------- |
|
||||
| `siteId` | query | string | 否 | 按站点 ID 筛选导出的评论数据,如 `blog`、`docs` |
|
||||
|
||||
说明:
|
||||
|
||||
- 当提供 `siteId` 参数且不为 `default` 时,仅导出该站点下的评论数据
|
||||
- 不提供 `siteId` 参数时,导出所有评论数据
|
||||
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
@@ -249,6 +260,17 @@ GET /admin/export/stats
|
||||
- 路径:`/admin/export/stats`
|
||||
- 鉴权:需要(Bearer Token)
|
||||
|
||||
**查询参数**
|
||||
|
||||
| 名称 | 位置 | 类型 | 必填 | 说明 |
|
||||
| -------- | ----- | ------ | ---- | ------------------------------- |
|
||||
| `siteId` | query | string | 否 | 按站点 ID 筛选导出的统计数据,如 `blog`、`docs` |
|
||||
|
||||
说明:
|
||||
|
||||
- 当提供 `siteId` 参数且不为 `default` 时,仅导出该站点下的统计数据(包括页面访问汇总、按日访问明细以及点赞明细)
|
||||
- 不提供 `siteId` 参数时,导出所有站点的统计数据
|
||||
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 统计数据
|
||||
|
||||
统计数据接口用于获取评论统计、域名列表等数据看板相关信息。
|
||||
统计数据接口用于获取评论统计、站点列表等数据看板相关信息。
|
||||
|
||||
所有接口都需要在请求头中携带 Bearer Token。
|
||||
|
||||
@@ -80,12 +80,12 @@ GET /admin/stats/comments
|
||||
| `summary.approved` | number | 已通过评论数 |
|
||||
| `summary.pending` | number | 待审核评论数 |
|
||||
| `summary.rejected` | number | 已拒绝评论数 |
|
||||
| `domains` | Array\<DomainStat\> | 按域名聚合的评论统计列表 |
|
||||
| `domains[].domain` | string | 解析后的域名(如 `example.com`) |
|
||||
| `domains[].total` | number | 该域名下评论总数 |
|
||||
| `domains[].approved` | number | 该域名下已通过评论数 |
|
||||
| `domains[].pending` | number | 该域名下待审核评论数 |
|
||||
| `domains[].rejected` | number | 该域名下已拒绝评论数 |
|
||||
| `domains` | Array\<DomainStat\> | 按站点聚合的评论统计列表 |
|
||||
| `domains[].domain` | string | 站点 ID(如 `blog`、`docs` 或 `default`) |
|
||||
| `domains[].total` | number | 该站点下评论总数 |
|
||||
| `domains[].approved` | number | 该站点下已通过评论数 |
|
||||
| `domains[].pending` | number | 该站点下待审核评论数 |
|
||||
| `domains[].rejected` | number | 该站点下已拒绝评论数 |
|
||||
| `last7Days` | Array\<DailyStat\> | 最近 30 天的每日评论数(按自然日聚合) |
|
||||
| `last7Days[].date` | string (YYYY-MM-DD) | 日期,UTC 时间格式化后的自然日 |
|
||||
| `last7Days[].total` | number | 当日评论总数 |
|
||||
|
||||
Reference in New Issue
Block a user