lumen.metrics.aggregate

Use for chart/table data: time-bucketed metric aggregates with optional grouping.

Query bucketed metric aggregates from Lumen.

Overview

Property	Value
Workflow type	Atomic
Library	App-lumen
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID to scope the query.
metric_name	string	Yes	—	Metric name or wildcard pattern.
project	string	No	—	Project filter; supports Lumen wildcards.
service_name	string	No	—	Exact service_name filter.
from	string	No	—	ISO 8601 lower time bound.
to	string	No	—	ISO 8601 upper time bound.
filters	list	No	—	Dimension filters as strings like attrs.env:prod or resource_attrs.namespace:default.
interval	string	No	—	Bucket interval: 5m, 1h, or 1d.
agg	string	No	—	Aggregation: avg, sum, min, max, count.
group_by	string	No	—	Optional group: project, service_name, attrs.<key>, or resource_attrs.<key>.
max_groups	integer	No	—	Grouped series cap; Lumen caps at 100.
recent_buckets	integer	No	—	Optional response trim: return only the latest N buckets, capped at 100.

Output Schema

Field	Type	Required	Default	Description
metric_name	string	Yes	—	—
interval	string	Yes	—	—
agg	string	Yes	—	—
group_by	string	No	—	—
max_groups	integer	No	—	—
truncated	boolean	No	—	—
from	string	No	—	—
to	string	No	—	—
buckets	list	Yes	—	Time buckets with aggregate values.
bucket_count	integer	No	—	—
returned_buckets	integer	No	—	—
buckets_limited	boolean	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
done	Yes	Yes	Yes	—	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "lumen.metrics.aggregate",
  "initial_data": {
    "organization_uuid": "value",
    "metric_name": "value"
  }
}