Skip to content

Get dashboard stats

GET
/api/v1/stats
curl --request GET \
--url https://osctrl.net/api/v1/stats \
--header 'Authorization: <Authorization>'

Returns cross-environment dashboard statistics.

OK

Media typeapplication/json
object
active_nodes
integer
environments

Per-env breakdown, in stable alphabetical order by name.

Array<object>
object
active
integer
active_carves
integer
active_queries
integer
inactive
integer
name
string
platform_counts

PlatformCounts buckets the env’s nodes by OS family (linux / darwin / windows / other). Drives the Nodes-table QuickFilters chip row. Counts are total (active + inactive), since the filter chip lists all nodes of that platform regardless of staleness — the Active/Inactive toggle is independent.

object
darwin
integer
linux
integer
other
integer
windows
integer
total
integer
uuid
string
inactive_hours
integer
inactive_nodes
integer
platform_counts

Cross-env platform breakdown — sum of every accessible env’s PlatformCounts.

object
darwin
integer
linux
integer
other
integer
windows
integer
total_active_carves

TotalActiveCarves counts active carve-type queries.

integer
total_active_queries

TotalActiveQueries counts standard query-type active queries (excludes carves).

integer
total_nodes

Cross-env totals (the user’s allowed envs only).

integer
Examplegenerated
{
"active_nodes": 1,
"environments": [
{
"active": 1,
"active_carves": 1,
"active_queries": 1,
"inactive": 1,
"name": "example",
"platform_counts": {
"darwin": 1,
"linux": 1,
"other": 1,
"windows": 1
},
"total": 1,
"uuid": "example"
}
],
"inactive_hours": 1,
"inactive_nodes": 1,
"platform_counts": {
"darwin": 1,
"linux": 1,
"other": 1,
"windows": 1
},
"total_active_carves": 1,
"total_active_queries": 1,
"total_nodes": 1
}

Bad request

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Unauthorized

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Forbidden

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Not found

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Conflict

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Too many requests

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Internal server error

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Service unavailable

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}