Class: DashboardClient

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

Client for AIRS SCM dashboard endpoints that power the "AI Security > Runtime > API Applications" panel.

The dashboard buckets traffic by the literal metadata.app_name value scan payloads actually sent. A single registered customer-app (customer_apps.customer_appId) can therefore map to multiple dashboard buckets, one per distinct scan-payload name. Use applicationsOverview to enumerate all dashboard buckets, then application and applicationViolationBreakdown to drill into any specific (id, name) pair.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const apps = await mgmt.customerApps.list();
const first = apps.customer_apps?.[0];
if (!first?.customer_appId) return;

const overview = await mgmt.dashboard.application({
  appId: first.customer_appId,
  appName: first.app_name,
});
// overview.token_stats?.monthly_total_tokens + scale ("K" | "M") = current month consumption

const violations = await mgmt.dashboard.applicationViolationBreakdown({
  appId: first.customer_appId,
  appName: first.app_name,
});
// violations.detection_type_violation_breakdown -> per-detector severity counts

Constructors

Constructor

new DashboardClient(opts): DashboardClient;

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

Parameters

Parameter	Type
`opts`	`DashboardClientOptions`

Returns

DashboardClient

Methods

application()

application(query): Promise<objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  cloud: ZodOptional<ZodNullable<ZodString>>;
  source: ZodOptional<ZodNullable<ZodString>>;
  created_at: ZodOptional<ZodNullable<ZodString>>;
  updated_at: ZodOptional<ZodNullable<ZodString>>;
  has_webhook_sig: ZodOptional<ZodBoolean>;
  profiles: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  token_stats: ZodNullable<ZodObject<{
     average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
     monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
     monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
     monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>;
     monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>;
  session_stats: ZodNullable<ZodObject<{
     total: ZodOptional<ZodNumber>;
     violating: ZodOptional<ZodNumber>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>>;
     last_session_id: ZodOptional<ZodNullable<ZodString>>;
     most_recent_session_time: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total: ZodOptional<ZodNumber>;
     violating: ZodOptional<ZodNumber>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>>;
     last_session_id: ZodOptional<ZodNullable<ZodString>>;
     most_recent_session_time: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total: ZodOptional<ZodNumber>;
     violating: ZodOptional<ZodNumber>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>>;
     last_session_id: ZodOptional<ZodNullable<ZodString>>;
     most_recent_session_time: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>;
}, ZodTypeAny, "passthrough">>;

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

Get per-application token consumption and session activity over the requested window.

Parameters

Parameter	Type	Description
`query`	`DashboardAppQuery`	App identity and time window. `appId` and `appName` are both required.

Returns

Promise<objectOutputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; cloud: ZodOptional<ZodNullable<ZodString>>; source: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; has_webhook_sig: ZodOptional<ZodBoolean>; profiles: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; token_stats: ZodNullable<ZodObject<{ average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>; average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>; monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>; monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>; average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>; monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>; monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ average_daily_tokens: ZodOptional<ZodNullable<ZodNumber>>; average_daily_tokens_scale: ZodOptional<ZodNullable<ZodString>>; monthly_total_tokens: ZodOptional<ZodNullable<ZodNumber>>; monthly_total_tokens_scale: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>>; session_stats: ZodNullable<ZodObject<{ total: ZodOptional<ZodNumber>; violating: ZodOptional<ZodNumber>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>>; last_session_id: ZodOptional<ZodNullable<ZodString>>; most_recent_session_time: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total: ZodOptional<ZodNumber>; violating: ZodOptional<ZodNumber>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>>; last_session_id: ZodOptional<ZodNullable<ZodString>>; most_recent_session_time: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total: ZodOptional<ZodNumber>; violating: ZodOptional<ZodNumber>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>>; last_session_id: ZodOptional<ZodNullable<ZodString>>; most_recent_session_time: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>

The application overview with token_stats, session_stats, attached profiles, and monitoring metadata.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const overview = await mgmt.dashboard.application({
  appId: 'd8dc4033-593b-45e7-9633-e0dfc130cc82',
  appName: 'chatbot',
});
// overview =>
// { name: 'chatbot', cloud: 'other', source: 'api',
//   token_stats: { average_daily_tokens: 744.233, average_daily_tokens_scale: 'K',
//                  monthly_total_tokens: 17.71, monthly_total_tokens_scale: 'M' },
//   session_stats: { total: 56935, violating: 31136, ... },
//   profiles: ['ms-tuned', 'golden-v2'] }

applicationRaw()

applicationRaw(query): Promise<unknown>;

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

Inspect per-application JSON without a response model. Empty body becomes undefined; debug bodies are suppressed. Query validation and OAuth still apply.

Parameters

Parameter	Type
`query`	`DashboardAppQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.applicationRaw({ appId: 'app-id', appName: 'chatbot', timeInterval: 30 });`

applicationViolationBreakdown()

applicationViolationBreakdown(query): Promise<objectOutputType<{
  detection_type_violation_breakdown: ZodArray<ZodObject<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  total_violating: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

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

Get per-detector violation severity counts for the application over the requested window.

Parameters

Parameter	Type	Description
`query`	`DashboardAppQuery`	App identity and time window. `appId` and `appName` are both required.

Returns

Promise<objectOutputType<{ detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>, "many">; total_violating: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

The detection-type breakdown (one entry per detector observed live: agent_security, contextual_grounding, dbs (database security), dlp, malicious_code, pi (prompt injection), source_code, tc (toxic content), topic_guardrails, uf (URL filtering)) plus total_violating. Detector set may evolve; .passthrough() schemas accept additions.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const breakdown = await mgmt.dashboard.applicationViolationBreakdown({
  appId: 'd8dc4033-593b-45e7-9633-e0dfc130cc82',
  appName: 'chatbot',
});
// breakdown =>
// { detection_type_violation_breakdown: [
//     { detection_type: 'topic_guardrails',
//       violation_breakdown: { critical: 0, high: 0, medium: 3, low: 0, total: 3 } },
//     { detection_type: 'dlp',
//       violation_breakdown: { critical: 0, high: 0, medium: 0, low: 0, total: 0 } },
//     ... ],
//   total_violating: 3 }

applicationViolationBreakdownRaw()

applicationViolationBreakdownRaw(query): Promise<unknown>;

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

Inspect per-detector breakdown JSON without imposing a response model. Empty body becomes undefined; debug bodies are suppressed.

Parameters

Parameter	Type
`query`	`DashboardAppQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.applicationViolationBreakdownRaw({ appId: 'app-id', appName: 'chatbot' });`

topApplicationsViolationsRaw()

topApplicationsViolationsRaw(query?): Promise<unknown>;

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

Inspect top-application policy-violation JSON. Defaults to the verified one-day window. Empty body becomes undefined; debug bodies are suppressed.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.topApplicationsViolationsRaw({ timeInterval: 1, timeUnit: 'day' });`

topApplicationsViolations()

topApplicationsViolations(query?): Promise<objectOutputType<{
  applications: ZodArray<ZodObject<{
     id: ZodString;
     name: ZodString;
     policy_violations: ZodArray<ZodObject<{
        detection_type: ZodString;
        total: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ZodString;
        total: ZodNumber;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ZodString;
        total: ZodNumber;
     }, ZodTypeAny, "passthrough">>, "many">;
     total_violations: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     name: ZodString;
     policy_violations: ZodArray<ZodObject<{
        detection_type: ZodString;
        total: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     total_violations: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     name: ZodString;
     policy_violations: ZodArray<ZodObject<{
        detection_type: ZodString;
        total: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     total_violations: ZodNumber;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

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

Retrieve the server's top applications by detector-policy violations. Defaults to one day; rankings are not a complete inventory or distinct-session counts.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<objectOutputType<{ applications: ZodArray<ZodObject<{ id: ZodString; name: ZodString; policy_violations: ZodArray<ZodObject<{ detection_type: ZodString; total: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ZodString; total: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ZodString; total: ZodNumber; }, ZodTypeAny, "passthrough">>, "many">; total_violations: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; name: ZodString; policy_violations: ZodArray<ZodObject<{ detection_type: ZodString; total: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; total: ...; }, ZodTypeAny, "passthrough">>, "many">; total_violations: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; name: ZodString; policy_violations: ZodArray<ZodObject<{ detection_type: ZodString; total: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; total: ...; }, ZodTypeAny, "passthrough">>, "many">; total_violations: ZodNumber; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example

`const top = await mgmt.dashboard.topApplicationsViolations({ timeInterval: 1, timeUnit: 'day' });`

applicationsViolationsTrendRaw()

applicationsViolationsTrendRaw(query?): Promise<unknown>;

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

Inspect aggregate violation-trend JSON. Defaults to the verified one-day window. Empty body becomes undefined; debug bodies are suppressed.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.applicationsViolationsTrendRaw({ timeInterval: 1, timeUnit: 'day' });`

applicationsViolationsTrend()

applicationsViolationsTrend(query?): Promise<objectOutputType<{
  violations: ZodArray<ZodObject<{
     bucket_number: ZodNumber;
     date: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
     }, ZodTypeAny, "passthrough">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     bucket_number: ZodNumber;
     date: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     bucket_number: ZodNumber;
     date: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

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

Retrieve aggregate severity counts over time, preserving server bucket order and timestamps. Defaults to one day. These counters need not equal distinct violating-session counts.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<objectOutputType<{ violations: ZodArray<ZodObject<{ bucket_number: ZodNumber; date: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; }, "passthrough", ZodTypeAny, objectOutputType<{ bucket_number: ZodNumber; date: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">, objectInputType<{ bucket_number: ZodNumber; date: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example

`const trend = await mgmt.dashboard.applicationsViolationsTrend({ timeInterval: 1, timeUnit: 'day' });`

appsListRaw()

appsListRaw(query?): Promise<unknown>;

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

Unstructured dashboard application identities; defaults to 30 days. Names and IDs can repeat.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.appsListRaw({ timeInterval: 30, timeUnit: 'days' });`

appsList()

appsList(query?): Promise<objectOutputType<{
  applications: ZodArray<ZodObject<{
     application_id: ZodString;
     application_name: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     application_id: ZodString;
     application_name: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     application_id: ZodString;
     application_name: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

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

Retrieve dashboard application identities. Defaults to 30 days; preserves duplicate names and IDs.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<objectOutputType<{ applications: ZodArray<ZodObject<{ application_id: ZodString; application_name: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ application_id: ZodString; application_name: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ application_id: ZodString; application_name: ZodString; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example

`const apps = await mgmt.dashboard.appsList({ timeInterval: 30, timeUnit: 'days' });`

sessionsChartRaw()

sessionsChartRaw(query?): Promise<unknown>;

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

Unstructured session-count time series; defaults to one day.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.sessionsChartRaw({ timeInterval: 1, timeUnit: 'day' });`

sessionsChart()

sessionsChart(query?): Promise<objectOutputType<{
  bucket_size_seconds: ZodNumber;
  buckets: ZodArray<ZodObject<{
     bucket_number: ZodNumber;
     time: ZodString;
     total: ZodNumber;
     violating: ZodNumber;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<ZodString>;
        violation_breakdown: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
     }, ZodTypeAny, "passthrough">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     bucket_number: ZodNumber;
     time: ZodString;
     total: ZodNumber;
     violating: ZodNumber;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        violation_breakdown: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        violation_breakdown: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     bucket_number: ZodNumber;
     time: ZodString;
     total: ZodNumber;
     violating: ZodNumber;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        violation_breakdown: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        violation_breakdown: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

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

Retrieve aggregate session-count buckets. Defaults to one day; violation counts remain separate.

Parameters

Parameter	Type
`query?`	`DashboardTimeRangeQuery`

Returns

Promise<objectOutputType<{ bucket_size_seconds: ZodNumber; buckets: ZodArray<ZodObject<{ bucket_number: ZodNumber; time: ZodString; total: ZodNumber; violating: ZodNumber; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; }, "passthrough", ZodTypeAny, objectOutputType<{ bucket_number: ZodNumber; time: ZodString; total: ZodNumber; violating: ZodNumber; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">, objectInputType<{ bucket_number: ZodNumber; time: ZodString; total: ZodNumber; violating: ZodNumber; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example

`const chart = await mgmt.dashboard.sessionsChart({ timeInterval: 1, timeUnit: 'day' });`

sessionsOverviewRaw()

sessionsOverviewRaw(query?): Promise<unknown>;

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

Unstructured paginated session inventory; defaults to one day, offset 0, limit 25.

Parameters

Parameter	Type
`query?`	`DashboardSessionsOverviewQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.sessionsOverviewRaw({ limit: 25, offset: 0 });`

sessionsOverview()

sessionsOverview(query?): Promise<objectOutputType<{
  items: ZodArray<ZodObject<{
     application_id: ZodString;
     application_name: ZodString;
   } & {
     session_id: ZodString;
     last_session_activity: ZodOptional<ZodNullable<ZodString>>;
     violation_status: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        violation_breakdown: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        violation_breakdown: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     application_id: ZodString;
     application_name: ZodString;
   } & {
     session_id: ZodString;
     last_session_activity: ZodOptional<ZodNullable<ZodString>>;
     violation_status: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ...;
        violation_breakdown: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     application_id: ZodString;
     application_name: ZodString;
   } & {
     session_id: ZodString;
     last_session_activity: ZodOptional<ZodNullable<ZodString>>;
     violation_status: ZodString;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ...;
        violation_breakdown: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
  }, ZodTypeAny, "passthrough">>, "many">;
  pagination: ZodObject<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
}, ZodTypeAny, "passthrough">>;

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

Retrieve one session-inventory page. Defaults to one day, offset 0, limit 25.

Parameters

Parameter	Type
`query?`	`DashboardSessionsOverviewQuery`

Returns

Promise<objectOutputType<{ items: ZodArray<ZodObject<{ application_id: ZodString; application_name: ZodString; } & { session_id: ZodString; last_session_activity: ZodOptional<ZodNullable<ZodString>>; violation_status: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">>, "many">; }, "passthrough", ZodTypeAny, objectOutputType<{ application_id: ZodString; application_name: ZodString; } & { session_id: ZodString; last_session_activity: ZodOptional<ZodNullable<ZodString>>; violation_status: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ...; violation_breakdown: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; }, ZodTypeAny, "passthrough">, objectInputType<{ application_id: ZodString; application_name: ZodString; } & { session_id: ZodString; last_session_activity: ZodOptional<ZodNullable<ZodString>>; violation_status: ZodString; violation_breakdown: ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ...; violation_breakdown: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; }, ZodTypeAny, "passthrough">>, "many">; pagination: ZodObject<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">>

Example

`const page = await mgmt.dashboard.sessionsOverview({ limit: 25, offset: 0 });`

sessionRaw()

sessionRaw(query): Promise<unknown>;

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

Unstructured session detail and actions. Defaults to 30 days. Bodies never enter SDK debug logs.

Parameters

Parameter	Type
`query`	`DashboardSessionQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.sessionRaw({ sessionId: 'session', appId: 'app', appName: 'demo' });`

session()

session(query): Promise<objectOutputType<{
  application: ZodObject<{
     id: ZodString;
     name: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     name: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     name: ZodString;
  }, ZodTypeAny, "passthrough">>;
  id: ZodString;
  session_actions: ZodArray<ZodObject<{
     application_id: ZodString;
     application_name: ZodString;
     session_id: ZodString;
     scan_id: ZodString;
     scan_sub_req_id: ZodNumber;
     transaction_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     start_time: ZodOptional<ZodString>;
     profile_name: ZodOptional<ZodString>;
     kind: ZodOptional<ZodArray<ZodString, "many">>;
     correlation_type: ZodOptional<ZodNullable<ZodString>>;
     enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<ZodString>;
        violation_breakdown: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
     }, ZodTypeAny, "passthrough">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     application_id: ZodString;
     application_name: ZodString;
     session_id: ZodString;
     scan_id: ZodString;
     scan_sub_req_id: ZodNumber;
     transaction_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     start_time: ZodOptional<ZodString>;
     profile_name: ZodOptional<ZodString>;
     kind: ZodOptional<ZodArray<ZodString, "many">>;
     correlation_type: ZodOptional<ZodNullable<ZodString>>;
     enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        violation_breakdown: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        violation_breakdown: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     application_id: ZodString;
     application_name: ZodString;
     session_id: ZodString;
     scan_id: ZodString;
     scan_sub_req_id: ZodNumber;
     transaction_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     start_time: ZodOptional<ZodString>;
     profile_name: ZodOptional<ZodString>;
     kind: ZodOptional<ZodArray<ZodString, "many">>;
     correlation_type: ZodOptional<ZodNullable<ZodString>>;
     enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>;
     detection_type_violation_breakdown: ZodArray<ZodObject<{
        detection_type: ZodOptional<...>;
        violation_breakdown: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        detection_type: ...;
        violation_breakdown: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        detection_type: ...;
        violation_breakdown: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     violation_breakdown: ZodObject<{
        critical: ZodOptional<ZodNumber>;
        high: ZodOptional<ZodNumber>;
        medium: ZodOptional<ZodNumber>;
        low: ZodOptional<ZodNumber>;
        total: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>;
  }, ZodTypeAny, "passthrough">>, "many">;
  pagination: ZodObject<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
  cloud: ZodOptional<ZodNullable<ZodString>>;
  source: ZodOptional<ZodNullable<ZodString>>;
  start_time: ZodOptional<ZodNullable<ZodString>>;
  end_time: ZodOptional<ZodNullable<ZodString>>;
  last_session_activity: ZodOptional<ZodNullable<ZodString>>;
  violation_status: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

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

Retrieve a session and one page of its actions. Defaults to 30 days; content is not fetched.

Parameters

Parameter	Type
`query`	`DashboardSessionQuery`

Returns

Promise<objectOutputType<{ application: ZodObject<{ id: ZodString; name: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; name: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; name: ZodString; }, ZodTypeAny, "passthrough">>; id: ZodString; session_actions: ZodArray<ZodObject<{ application_id: ZodString; application_name: ZodString; session_id: ZodString; scan_id: ZodString; scan_sub_req_id: ZodNumber; transaction_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; start_time: ZodOptional<ZodString>; profile_name: ZodOptional<ZodString>; kind: ZodOptional<ZodArray<ZodString, "many">>; correlation_type: ZodOptional<ZodNullable<ZodString>>; enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; }, "passthrough", ZodTypeAny, objectOutputType<{ application_id: ZodString; application_name: ZodString; session_id: ZodString; scan_id: ZodString; scan_sub_req_id: ZodNumber; transaction_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; start_time: ZodOptional<ZodString>; profile_name: ZodOptional<ZodString>; kind: ZodOptional<ZodArray<ZodString, "many">>; correlation_type: ZodOptional<ZodNullable<ZodString>>; enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">, objectInputType<{ application_id: ZodString; application_name: ZodString; session_id: ZodString; scan_id: ZodString; scan_sub_req_id: ZodNumber; transaction_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; start_time: ZodOptional<ZodString>; profile_name: ZodOptional<ZodString>; kind: ZodOptional<ZodArray<ZodString, "many">>; correlation_type: ZodOptional<ZodNullable<ZodString>>; enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<...>; violation_breakdown: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ...; violation_breakdown: ...; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">>, "many">; pagination: ZodObject<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; cloud: ZodOptional<ZodNullable<ZodString>>; source: ZodOptional<ZodNullable<ZodString>>; start_time: ZodOptional<ZodNullable<ZodString>>; end_time: ZodOptional<ZodNullable<ZodString>>; last_session_activity: ZodOptional<ZodNullable<ZodString>>; violation_status: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

Example

`const detail = await mgmt.dashboard.session({ sessionId: 'session', appId: 'app', appName: 'demo', limit: 25, offset: 0 });`

sessionTransactionRaw()

sessionTransactionRaw(query): Promise<unknown>;

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

Unstructured transaction detail. Bodies never enter SDK debug logs.

Parameters

Parameter	Type
`query`	`DashboardSessionTransactionQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.sessionTransactionRaw({ sessionId: 'session', appId: 'app', appName: 'demo', scanId: 'scan', scanSubReqId: 0 });`

sessionTransaction()

sessionTransaction(query): Promise<objectOutputType<{
  application_id: ZodString;
  application_name: ZodString;
  session_id: ZodString;
  scan_id: ZodString;
  scan_sub_req_id: ZodNumber;
  transaction_id: ZodOptional<ZodString>;
  status: ZodOptional<ZodString>;
  start_time: ZodOptional<ZodString>;
  profile_name: ZodOptional<ZodString>;
  kind: ZodOptional<ZodArray<ZodString, "many">>;
  correlation_type: ZodOptional<ZodNullable<ZodString>>;
  enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>;
  detection_type_violation_breakdown: ZodArray<ZodObject<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ZodOptional<...>;
        high: ZodOptional<...>;
        medium: ZodOptional<...>;
        low: ZodOptional<...>;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     detection_type: ZodOptional<ZodString>;
     violation_breakdown: ZodOptional<ZodObject<{
        critical: ...;
        high: ...;
        medium: ...;
        low: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  violation_breakdown: ZodObject<{
     critical: ZodOptional<ZodNumber>;
     high: ZodOptional<ZodNumber>;
     medium: ZodOptional<ZodNumber>;
     low: ZodOptional<ZodNumber>;
     total: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     critical: ZodOptional<ZodNumber>;
     high: ZodOptional<ZodNumber>;
     medium: ZodOptional<ZodNumber>;
     low: ZodOptional<ZodNumber>;
     total: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     critical: ZodOptional<ZodNumber>;
     high: ZodOptional<ZodNumber>;
     medium: ZodOptional<ZodNumber>;
     low: ZodOptional<ZodNumber>;
     total: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
} & {
  ai_traffic_latency_ms: ZodOptional<ZodNumber>;
  attributes: ZodOptional<ZodObject<{
     environment: ZodOptional<ZodNullable<ZodString>>;
     model_name: ZodOptional<ZodNullable<ZodString>>;
     profile: ZodOptional<ZodNullable<ZodString>>;
     text_records: ZodOptional<ZodNumber>;
     user_id: ZodOptional<ZodNullable<ZodString>>;
     user_ip: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     environment: ZodOptional<ZodNullable<ZodString>>;
     model_name: ZodOptional<ZodNullable<ZodString>>;
     profile: ZodOptional<ZodNullable<ZodString>>;
     text_records: ZodOptional<ZodNumber>;
     user_id: ZodOptional<ZodNullable<ZodString>>;
     user_ip: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     environment: ZodOptional<ZodNullable<ZodString>>;
     model_name: ZodOptional<ZodNullable<ZodString>>;
     profile: ZodOptional<ZodNullable<ZodString>>;
     text_records: ZodOptional<ZodNumber>;
     user_id: ZodOptional<ZodNullable<ZodString>>;
     user_ip: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>;
  end_time: ZodOptional<ZodNullable<ZodString>>;
  timeout: ZodOptional<ZodBoolean>;
  tokens: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

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

Retrieve transaction metadata, preserving null and literal sentinel values. Defaults to 30 days.

Parameters

Parameter	Type
`query`	`DashboardSessionTransactionQuery`

Returns

Promise<objectOutputType<{ application_id: ZodString; application_name: ZodString; session_id: ZodString; scan_id: ZodString; scan_sub_req_id: ZodNumber; transaction_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; start_time: ZodOptional<ZodString>; profile_name: ZodOptional<ZodString>; kind: ZodOptional<ZodArray<ZodString, "many">>; correlation_type: ZodOptional<ZodNullable<ZodString>>; enable_full_conversation_inspection: ZodOptional<ZodNullable<ZodBoolean>>; detection_type_violation_breakdown: ZodArray<ZodObject<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ZodOptional<...>; high: ZodOptional<...>; medium: ZodOptional<...>; low: ZodOptional<...>; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, ZodTypeAny, "passthrough">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ detection_type: ZodOptional<ZodString>; violation_breakdown: ZodOptional<ZodObject<{ critical: ...; high: ...; medium: ...; low: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; }, ZodTypeAny, "passthrough">>, "many">; violation_breakdown: ZodObject<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ critical: ZodOptional<ZodNumber>; high: ZodOptional<ZodNumber>; medium: ZodOptional<ZodNumber>; low: ZodOptional<ZodNumber>; total: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; } & { ai_traffic_latency_ms: ZodOptional<ZodNumber>; attributes: ZodOptional<ZodObject<{ environment: ZodOptional<ZodNullable<ZodString>>; model_name: ZodOptional<ZodNullable<ZodString>>; profile: ZodOptional<ZodNullable<ZodString>>; text_records: ZodOptional<ZodNumber>; user_id: ZodOptional<ZodNullable<ZodString>>; user_ip: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ environment: ZodOptional<ZodNullable<ZodString>>; model_name: ZodOptional<ZodNullable<ZodString>>; profile: ZodOptional<ZodNullable<ZodString>>; text_records: ZodOptional<ZodNumber>; user_id: ZodOptional<ZodNullable<ZodString>>; user_ip: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ environment: ZodOptional<ZodNullable<ZodString>>; model_name: ZodOptional<ZodNullable<ZodString>>; profile: ZodOptional<ZodNullable<ZodString>>; text_records: ZodOptional<ZodNumber>; user_id: ZodOptional<ZodNullable<ZodString>>; user_ip: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>>; end_time: ZodOptional<ZodNullable<ZodString>>; timeout: ZodOptional<ZodBoolean>; tokens: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

Example

`const tx = await mgmt.dashboard.sessionTransaction({ sessionId: 'session', appId: 'app', appName: 'demo', scanId: 'scan', scanSubReqId: 0 });`

scanContentRaw()

scanContentRaw(query): Promise<unknown>;

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

Explicitly retrieve potentially sensitive scan content from the same dashboard host. No automatic content retrieval is performed by session methods; bodies never enter SDK debug logs.

Parameters

Parameter	Type
`query`	`DashboardScanContentQuery`

Returns

Promise<unknown>

Example

`const raw = await mgmt.dashboard.scanContentRaw({ scanId: 'scan', scanSubReqId: 0 });`

scanContent()

scanContent(query): Promise<objectOutputType<{
  report_id: ZodString;
  scan_id: ZodString;
  sub_scan_req_id: ZodNumber;
  transaction_id: ZodString;
  scan_contents: ZodNullable<ZodObject<{
     prompt: ZodOptional<ZodNullable<ZodString>>;
     response: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     prompt: ZodOptional<ZodNullable<ZodString>>;
     response: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     prompt: ZodOptional<ZodNullable<ZodString>>;
     response: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>;
}, ZodTypeAny, "passthrough">>;

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

Explicitly retrieve scan content from /v1/mgmt/reports/scancontent on the configured dashboard host. This may expose prompts/responses; SDK debug bodies are always suppressed. Never fetched automatically.

Parameters

Parameter	Type
`query`	`DashboardScanContentQuery`

Returns

Promise<objectOutputType<{ report_id: ZodString; scan_id: ZodString; sub_scan_req_id: ZodNumber; transaction_id: ZodString; scan_contents: ZodNullable<ZodObject<{ prompt: ZodOptional<ZodNullable<ZodString>>; response: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ prompt: ZodOptional<ZodNullable<ZodString>>; response: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ prompt: ZodOptional<ZodNullable<ZodString>>; response: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>

Example

`const report = await mgmt.dashboard.scanContent({ scanId: 'scan', scanSubReqId: 0 }); // protect report.scan_contents`

applicationsOverview()

applicationsOverview(query?): Promise<objectOutputType<{
  items: ZodArray<ZodObject<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     cloud: ZodOptional<ZodNullable<ZodString>>;
     source: ZodOptional<ZodNullable<ZodString>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        bucket_number: ...;
        date: ...;
        total: ...;
        violated: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
     sessions_total: ZodOptional<ZodNullable<ZodNumber>>;
     sessions_violated: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     cloud: ZodOptional<ZodNullable<ZodString>>;
     source: ZodOptional<ZodNullable<ZodString>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     sessions_total: ZodOptional<ZodNullable<ZodNumber>>;
     sessions_violated: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     cloud: ZodOptional<ZodNullable<ZodString>>;
     source: ZodOptional<ZodNullable<ZodString>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     sessions_total: ZodOptional<ZodNullable<ZodNumber>>;
     sessions_violated: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  pagination: ZodOptional<ZodObject<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     limit: ZodOptional<ZodNumber>;
     skip: ZodOptional<ZodNumber>;
     total_items: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
}, ZodTypeAny, "passthrough">>;

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

Enumerate all dashboard application buckets the tenant has data for.

This is the canonical apps-list source for the dashboard. The customer-apps endpoint (mgmt.customerApps.list) lists registered customer applications, but each registered customer-app can have multiple dashboard buckets when its API key is used to send scan requests carrying different metadata.app_name values - one bucket per distinct scan-payload name. This endpoint returns every bucket, so it is what you want for per-app token-consumption reporting and dashboard inventory.

The id field on each item is the registered customer_appId UUID; the name field is the scan-payload value. Pass that (id, name) pair to application or applicationViolationBreakdown to retrieve drill-down data for a specific bucket.

Parameters

Parameter	Type	Description
`query?`	`DashboardApplicationsOverviewQuery`	Time window and pagination.

Returns

Promise<objectOutputType<{ items: ZodArray<ZodObject<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; cloud: ZodOptional<ZodNullable<ZodString>>; source: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<{ bucket_number: ...; date: ...; total: ...; violated: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>; sessions_total: ZodOptional<ZodNullable<ZodNumber>>; sessions_violated: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; cloud: ZodOptional<ZodNullable<ZodString>>; source: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>; sessions_total: ZodOptional<ZodNullable<ZodNumber>>; sessions_violated: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; cloud: ZodOptional<ZodNullable<ZodString>>; source: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; sessions: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>; sessions_total: ZodOptional<ZodNullable<ZodNumber>>; sessions_violated: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>, "many">; pagination: ZodOptional<ZodObject<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ limit: ZodOptional<ZodNumber>; skip: ZodOptional<ZodNumber>; total_items: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>

Paginated bucket list plus pagination metadata.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();

const { items } = await mgmt.dashboard.applicationsOverview();
for (const item of items ?? []) {
  const overview = await mgmt.dashboard.application({
    appId: item.id ?? '',
    appName: item.name ?? '',
  });
  console.log(item.name, overview.token_stats?.monthly_total_tokens);
}

applicationsOverviewRaw()

applicationsOverviewRaw(query?): Promise<unknown>;

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

Retrieve unstructured JSON for an undocumented dashboard deployment. Uses the same OAuth, tenant routing, query, and retry workflow as the typed method. No response fields are validated or discarded. An empty HTTP body returns undefined, not an invented empty result. Prefer applicationsOverview for normal consumers.

Parameters

Parameter	Type
`query?`	`DashboardApplicationsOverviewQuery`

Returns

Promise<unknown>

Example

const mgmt = new ManagementClient({
  dashboardEndpoint: 'https://api.apps.paloaltonetworks.com/aisec',
});
const raw: unknown = await mgmt.dashboard.applicationsOverviewRaw({
  timeInterval: 1, timeUnit: 'day', limit: 25, offset: 0,
});

Example​

Constructors​

Constructor​

Parameters​

Returns​

Methods​

application()​

Parameters​

Returns​

Example​

applicationRaw()​

Parameters​

Returns​

Example​

applicationViolationBreakdown()​

Parameters​

Returns​

Example​

applicationViolationBreakdownRaw()​

Parameters​

Returns​

Example​

topApplicationsViolationsRaw()​

Parameters​

Returns​

Example​

topApplicationsViolations()​

Parameters​

Returns​

Example​

applicationsViolationsTrendRaw()​

Parameters​

Returns​

Example​

applicationsViolationsTrend()​

Parameters​

Returns​

Example​

appsListRaw()​

Parameters​

Returns​

Example​

appsList()​

Parameters​

Returns​

Example​

sessionsChartRaw()​

Parameters​

Returns​

Example​

sessionsChart()​

Parameters​

Returns​

Example​

sessionsOverviewRaw()​

Parameters​

Returns​

Example​

sessionsOverview()​

Parameters​

Returns​

Example​

sessionRaw()​

Parameters​

Returns​

Example​

session()​

Parameters​

Returns​

Example​

sessionTransactionRaw()​

Parameters​

Returns​

Example​

sessionTransaction()​

Parameters​

Returns​

Example​

scanContentRaw()​

Parameters​

Example

Constructors

Constructor

Parameters

Returns

Methods

application()

Parameters

Returns

Example

applicationRaw()

Parameters

Returns

Example

applicationViolationBreakdown()

Parameters

Returns

Example

applicationViolationBreakdownRaw()

Parameters

Returns

Example

topApplicationsViolationsRaw()

Parameters

Returns

Example

topApplicationsViolations()

Parameters

Returns

Example

applicationsViolationsTrendRaw()

Parameters

Returns

Example

applicationsViolationsTrend()

Parameters

Returns

Example

appsListRaw()

Parameters

Returns

Example

appsList()

Parameters

Returns

Example

sessionsChartRaw()

Parameters

Returns

Example

sessionsChart()

Parameters

Returns

Example

sessionsOverviewRaw()

Parameters

Returns

Example

sessionsOverview()

Parameters

Returns

Example

sessionRaw()

Parameters

Returns

Example

session()

Parameters

Returns

Example

sessionTransactionRaw()

Parameters

Returns

Example

sessionTransaction()

Parameters

Returns

Example

scanContentRaw()

Parameters