仪表盘
仪表盘分为总览、趋势、课堂、进课质量、用量和课件异常六部分。查询使用 preset 与 timezone,可按 appId 和 environment 筛选;自定义日期范围使用 fromDate、toDate。响应的 window 包含时间窗口和数据可用范围。
分区的 status=unavailable 表示该分区数据不可用,不能作为零值统计。window.asOf 标识响应的统计截止时刻。
dashboard.overview
总览。
GET /v1/dashboard/overview
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.overview(input) |
| Python | c.dashboard.overview(**input) |
| Java | c.dashboard.overview(input) |
| Go | c.Dashboard.Overview(ctx, input, &result) |
| PHP | $c->dashboard->overview($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'overview'>。嵌套字段见共享类型。
dashboard.trends
趋势。
GET /v1/dashboard/trends
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.trends(input) |
| Python | c.dashboard.trends(**input) |
| Java | c.dashboard.trends(input) |
| Go | c.Dashboard.Trends(ctx, input, &result) |
| PHP | $c->dashboard->trends($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'trends'>。嵌套字段见共享类型。
dashboard.classrooms
课堂统计。
GET /v1/dashboard/classrooms
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.classrooms(input) |
| Python | c.dashboard.classrooms(**input) |
| Java | c.dashboard.classrooms(input) |
| Go | c.Dashboard.Classrooms(ctx, input, &result) |
| PHP | $c->dashboard->classrooms($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'classrooms'>。嵌套字段见共享类型。
dashboard.quality
进课质量。
GET /v1/dashboard/quality
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.quality(input) |
| Python | c.dashboard.quality(**input) |
| Java | c.dashboard.quality(input) |
| Go | c.Dashboard.Quality(ctx, input, &result) |
| PHP | $c->dashboard->quality($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'quality'>。嵌套字段见共享类型。
dashboard.usage
用量汇总。
GET /v1/dashboard/usage
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.usage(input) |
| Python | c.dashboard.usage(**input) |
| Java | c.dashboard.usage(input) |
| Go | c.Dashboard.Usage(ctx, input, &result) |
| PHP | $c->dashboard->usage($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'usage'>。嵌套字段见共享类型。
dashboard.issues
课件异常。
GET /v1/dashboard/issues
鉴权:租户 Bearer Token。
| 语言 | 调用 |
|---|---|
| Node.js | c.dashboard.issues(input) |
| Python | c.dashboard.issues(**input) |
| Java | c.dashboard.issues(input) |
| Go | c.Dashboard.Issues(ctx, input, &result) |
| PHP | $c->dashboard->issues($input) |
输入:DashboardQuery。 字段放在 URL 查询参数中。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
appId | 否 | string | undefined | 目标应用 ID |
environment | 否 | string | undefined | 应用环境 |
preset | 是 | DashboardPreset | today、yesterday、7d、30d 或 custom |
timezone | 是 | string | IANA 时区,例如 Asia/Shanghai |
fromDate | 否 | string | undefined | 自定义范围开始日期 |
toDate | 否 | string | undefined | 自定义范围结束日期 |
返回:DashboardResponse<'issues'>。嵌套字段见共享类型。