Skip to main content

Interface: DashboardAppQuery

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

Query parameters shared by both dashboard application endpoints.

Both appId and a non-empty appName are required by the API. Sending an empty appname returns HTTP 400; omitting the parameter entirely (different code path) returns an all-null body. The SDK signature requires a non-empty appName to keep both failure modes off the happy path.

Properties​

appId​

appId: string;

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

Customer application UUID. Source it from import('./customer-apps.js').CustomerAppsClient.list's customer_appId field.

appName​

appName: string;

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

Application display name as the dashboard tracks it - the literal metadata.app_name value scan payloads sent. This may differ from the customer_apps.app_name field when the integration overrides it (LiteLLM's panw_prisma_airs guardrail does this by default, for example). Required, non-empty. URL encoding is handled internally.

To enumerate all valid (appId, appName) pairs the dashboard tracks, use DashboardClient.applicationsOverview - one item per dashboard bucket.

timeInterval?​

optional timeInterval?: 60 | 7 | 30;

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

Look-back window length, in days. Defaults to 30 (matches the SCM UI's "30 days" claim). The API accepts an enum-like set rather than an arbitrary integer; values verified accepted on 2026-05-28 are 7, 30, and 60. Other values (1, 3, 14, 21, 28, 90) all returned HTTP 400. Widen this union if the API later accepts more.

timeUnit?​

optional timeUnit?: "days";

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

Look-back window unit. Only 'days' is supported by the API as of verification (2026-05-28); 'hours' / 'minutes' return HTTP 400.