Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

API reference Resources

Overview

The workspace's posture at a glance: counts and names, never content.

1 operation

Workspace overview

GET/overview

The workspace's posture over the trailing window: totals, a per-day series, the services and tools that carried AI traffic, and the issue mix. Counts and names only, never content: no prompt text, preview or attachment name. Needs the same permission as reading machines and interactions.

Query parameters

daysinteger · null

Trailing window, in UTC days. Default 30, clamped to 1..=90.

Response200

The workspace's posture over the window

daysOverviewDay[]required

Oldest first, zero-filled, exactly window_days long.

alertedintegerrequired
blockedintegerrequired
daystringrequired

YYYY-MM-DD.

interactionsintegerrequired

Interactions observed that day.

justifiedintegerrequired
passedintegerrequired
edgesOverviewEdge[]required

At most 100.

blockedintegerrequired
interactionsintegerrequired
servicestringrequired
toolstringrequired
issuesOverviewIssuesrequired
openintegerrequired

Issues whose status is open.

open_by_kindOpenByKind[]required

Largest first.

open_by_severityOpenBySeverityrequired

Open issues by severity. Every key is always present.

totalintegerrequired

Every issue in the workspace, whatever its status.

servicesOverviewService[]required

Largest first by interactions, then by name; at most 20.

blockedintegerrequired

Interactions with at least one blocked decision, each once.

cataloguedbooleanrequired

Whether an enabled catalogue entry matches: its service_id equals service, or one of its patterns covers it (hook and proxy rows record a host). False is Shadow AI.

interactionsintegerrequired
machinesintegerrequired

Distinct machines that talked to it.

request_bytesintegerrequired
servicestringrequired

The AI service, as interactions record it, e.g. claude.ai.

toolsOverviewTool[]required

Largest first; at most 20.

blockedintegerrequired
interactionsintegerrequired
namestringrequired

The client's declared name; its client_kind word when it declared none; other when neither — the machine map's naming.

kindstring · null

The commonest declared client kind among its interactions.

total_servicesintegerrequired

Distinct services before the cap.

total_toolsintegerrequired

Distinct tools before the cap.

totalsOverviewTotalsrequired
blockedintegerrequired

Interactions with at least one blocked decision, each counted once.

interactionsintegerrequired

Interactions observed in the window.

machines_reportingintegerrequired

Distinct machines among the interactions. Connection-ingested interactions have no machine and are not counted here.

request_bytesintegerrequired

Bytes sent to AI services in the window.

servicesintegerrequired

Distinct AI services.

shadow_servicesintegerrequired

Distinct AI services no enabled catalogue entry matches, by id or by pattern: Shadow AI. Counted over every service, not only the listed.

window_daysintegerrequired

The window actually used, after clamping.

Errors

401

No valid session

403

Caller lacks machines:read in this workspace