Preview - Time-bucketed metric series per command for one tool

get

https://{region}.api.jamfcloud.com/ai/governance/visibility/v1/tools/{tool_id}/commands/stats

Preview: This endpoint is currently in a preview state and is subject to breaking changes without warning.

Preview endpoint. This endpoint is in preview: its request and response shapes may change without a version increment. A v2 of this API is planned to supersede it, targeting 2026-11.

For a single tool, returns the chosen metric bucketed into bin-sized intervals across the time range, as one series per command (filtered to rows for tool_id, read from device_tool_command_hourly). Each per-bin value also carries the highest severity observed in that bin. Bin alignment and bin=all behave as on /v1/tools/stats.

Required Permissions: ai-visibility:read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tool_id

string

required

Query Params

start

date-time

Absolute inclusive UTC start timestamp (RFC3339). Must be paired with end; cannot be combined with range.

end

date-time

Absolute exclusive UTC end timestamp (RFC3339). Must be paired with start; cannot be combined with range.

range

string

^\s*(?:\d+w)?\s*(?:\d+d)?\s*(?:\d+h)?\s*$

Relative look-back duration composed of optional weeks (w), days (d), and hours (h) segments, in that order (e.g. 24h, 7d, 1w, 1w2d3h). Resolved server-side to [now-range, now). Mutually exclusive with start/end. Defaults to 24h when no time parameters are supplied.

string

Defaults to UTC

IANA timezone name (e.g. America/New_York, Europe/Paris) used to express the resolved range. For the stats endpoints it aligns day and week bin boundaries to that timezone's local midnight / start-of-week before the window is normalized to UTC for querying. Has no effect on endpoints that do not bucket by time. Defaults to UTC when omitted.

bin

string

enum

required

Time-bucket granularity. Cannot be finer than hour (the storage grain). Use all to collapse the whole range into a single bin. The server rejects range/bin combinations that produce too many bins with 400 invalid_window_bin_combination.

Allowed:

metric

string

enum

Defaults to device_count

Single metric to chart. Defaults to device_count.

Allowed:

fill

boolean

Defaults to false

When true, emit a point for every bin in the range (missing bins filled with 0) so series are dense for charting. When false (default), only bins that have data are returned.

Headers

X-Environment-Id

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Time series for the tool, one entry per command

400Missing or invalid parameter - e.g. unparseable start/end/range, range combined with start+end, invalid metric, out-of-range limit/order, invalid bin/fill, an analytic UUID or severity integer that doesn't parse, or a malformed cursor.

401Missing, malformed, expired, or otherwise invalid JWT bearer token. Returned by the auth middleware before the handler runs.

403The token is valid but its tenant claim could not be resolved into a usable tenant schema (e.g. the tenantId is missing or malformed).

500Unexpected error querying the backing store.