Dashboard
Console client configuration · Response and shared models
The dashboard exposes overview, trends, classrooms, entry quality, usage, and courseware issues. Queries use preset and timezone, with optional application and environment filters. Custom date ranges use fromDate and toDate. The response window includes time boundaries and data availability.
A section with status=unavailable represents unavailable data and is not a zero count. window.asOf is the response’s observation cutoff.
dashboard.overview
Overview.
GET /v1/dashboard/overview
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'overview'>. See shared models for nested fields.
dashboard.trends
Trends.
GET /v1/dashboard/trends
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'trends'>. See shared models for nested fields.
dashboard.classrooms
Classroom statistics.
GET /v1/dashboard/classrooms
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'classrooms'>. See shared models for nested fields.
dashboard.quality
Entry quality.
GET /v1/dashboard/quality
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'quality'>. See shared models for nested fields.
dashboard.usage
Usage summary.
GET /v1/dashboard/usage
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'usage'>. See shared models for nested fields.
dashboard.issues
Courseware issues.
GET /v1/dashboard/issues
Authentication: tenant Bearer token.
| Language | Call |
|---|---|
| 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) |
Input: DashboardQuery. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
appId | No | string | undefined | Target application ID |
environment | No | string | undefined | Application environment |
preset | Yes | DashboardPreset | today, yesterday, 7d, 30d, or custom |
timezone | Yes | string | IANA timezone, for example Asia/Shanghai |
fromDate | No | string | undefined | Custom range start date |
toDate | No | string | undefined | Custom range end date |
Returns: DashboardResponse<'issues'>. See shared models for nested fields.