Skip to main content

Interface: DashboardApplicationsOverviewQuery

Defined in: src/management/dashboard.ts:68

Query parameters for DashboardClient.applicationsOverview.

Distinct from DashboardAppQuery - this endpoint takes no appId/appName (it is the enumeration source for those) and accepts a wider set of time windows.

Properties

timeInterval?

optional timeInterval?: 1 | 60 | 7 | 30;

Defined in: src/management/dashboard.ts:77

Look-back window length. Accepted values vary by timeUnit:

  • timeUnit: 'days' accepts 7, 30, or 60.
  • timeUnit: 'day' accepts 1.
  • timeUnit: 'hour' accepts 1.

Defaults to 30. Other combinations return HTTP 400.


timeUnit?

optional timeUnit?: "days" | "day" | "hour";

Defined in: src/management/dashboard.ts:83

Look-back window unit. The dashboard apps-overview endpoint accepts 'days', 'day', and 'hour' (note the singular forms - unlike the per-app application endpoint, which only accepts 'days'). Defaults to 'days'.


limit?

optional limit?: number;

Defined in: src/management/dashboard.ts:85

Maximum items to return. Defaults to 25 (matches the SCM UI).


offset?

optional offset?: number;

Defined in: src/management/dashboard.ts:87

Number of items to skip (offset-based pagination). Defaults to 0.