Get instruction stats (dashboard aggregates)

Returns aggregate counts for the organization, used by the Workbench Dashboard Metrics widget:

  • by_time_bucket — scheduled (pending|queued) counts in the
    overdue bucket (execution_datetime already past — exactly what
    the next cron tick will pick up) plus the cumulative forward
    windows next_1hnext_4hnext_24h, anchored at query
    time. Buckets are disjoint from overdue, so
    overdue + next_24h reconciles with the total scheduled within
    24 hours.
  • by_status_over_time — hourly status-transition counts over the
    trailing 24 hours. Sparse: only (bucket, status) pairs with a
    non-zero count are returned.
  • total — grand total honouring the filters.

Hidden instructions are included only when the requester holds instructions:read_hidden.

Permission: instructions:read (plus instructions:read_hidden to include hidden instructions in the counts).

Query Params
status
array of objects

Filter by one or more statuses.

status
Allowed:
uuid

Scope the stats to a single module (of any type).

string
enum

Scope the stats to one module domain (product_module or collection_module).

Allowed:
date-time

Inclusive lower bound on execution_datetime (ISO 8601, UTC if no offset supplied).

date-time

Inclusive upper bound on execution_datetime (ISO 8601, UTC if no offset supplied).

Responses

403

Missing instructions:read permission.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json