Summarize the organization's Sandboxes: counts by state and provider, recent creations, running time, recoveries and how many need attention.

GET

/v1/sandboxes/stats

const url = 'https://app.everruns.com/api/v1/sandboxes/stats';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.everruns.com/api/v1/sandboxes/stats

Parameters

Query Parameters

state

string

Comma-separated states: running, paused, lost, starting, failed, not_started, deleted, or live for the first five.

provider

string

Comma-separated provider ids, such as daytona,modal.

agent_id

string

Only Sandboxes of Sessions that ran this Agent.

sandbox_template_id

string

Only Sandboxes created from this Sandbox Template.

needs_attention

boolean

Only Sandboxes with at least one attention reason.

search

string

Case-insensitive match on Session title, Agent, provider or provider resource id.

include_in_process

boolean

Include in-process targets (virtual filesystem, host), which have no provider resource.

Responses

200

Success

application/json

Roll-ups for the fleet summary.

object

by_state

required

Sandboxes per state.

Array<object>

A count keyed by a label.

object

count

required

integer format: int64

key

required

string

created_in_prior_window

required

Created in the window before, for a trend.

integer format: int64

created_in_window

required

integer format: int64

live_by_provider

required

Live Sandboxes per provider.

Array<object>

A count keyed by a label.

object

count

required

integer format: int64

key

required

string

needs_attention

required

Sandboxes with at least one attention reason.

integer format: int64

recoveries_in_window

required

Provider resources lost and rebuilt in the window.

integer format: int64

running_seconds_in_window

required

Total time Sandboxes spent running in the window.

integer format: int64

window_days

required

Days covered by the *_in_window figures.

integer format: int64

Example

{
  "by_state": [
    {
      "count": 5,
      "key": "running"
    }
  ],
  "live_by_provider": [
    {
      "count": 5,
      "key": "running"
    }
  ],
  "window_days": 7
}