Data Aggregator¶
Class: DataAggregatorBlockV1
Source: inference.core.workflows.core_steps.analytics.data_aggregator.v1.DataAggregatorBlockV1
Collect and process data from workflow steps over configurable time-based or run-based intervals to generate statistical summaries and analytics reports, supporting multiple aggregation operations (sum, average, max, min, count, distinct values, value counts) with optional UQL-based data transformations for comprehensive data stream analytics.
How This Block Works¶
This block collects and aggregates data from workflow steps over specified intervals to produce statistical summaries. Unlike most blocks that output data for every input, this block maintains internal state and outputs aggregated results only when the configured interval is reached. The block:
- Receives data inputs from other workflow steps (via
datafield mapping variable names to workflow step outputs) - Optionally applies UQL (Query Language) operations to transform the data before aggregation (e.g., extract class names from detections, calculate sequence lengths, filter or transform values) using
data_operationsfor each input variable - Accumulates data into internal aggregation states based on the specified
aggregation_modefor each variable - Tracks time elapsed or number of runs based on
interval_unit(seconds, minutes, hours, or runs) - Most of the time, returns empty outputs (terminating downstream processing) while collecting data internally
- When the interval threshold is reached (based on time elapsed or run count), computes and outputs aggregated statistics
- Flushes internal state after outputting aggregated results and starts collecting data for the next interval
- Produces output fields dynamically named as
{variable_name}_{aggregation_mode}(e.g.,predictions_avg,classes_distinct,count_values_counts)
The block supports multiple aggregation modes for numeric data (sum, avg, max, min, values_difference), counting operations (count, count_distinct), and value analysis (distinct, values_counts). For list-like data, operations automatically process each element (e.g., count adds list length, distinct adds each element to the distinct set). The interval can be time-based (useful for video streams where wall-clock time matters) or run-based (useful for video file processing where frame count matters more than elapsed time).
Common Use Cases¶
- Video Stream Analytics: Aggregate detection results over time intervals from live video streams (e.g., calculate average object counts per minute, track distinct classes seen per hour, compute min/max detection counts over 30-second windows), enabling real-time analytics and monitoring for continuous video processing workflows
- Batch Video Processing: Aggregate statistics across video frames using run-based intervals (e.g., calculate average detections per 100 frames, count distinct objects across 500-frame windows, sum total detections per batch), enabling meaningful analytics for pre-recorded video files where frame count matters more than elapsed time
- Time-Series Metrics Collection: Collect and summarize workflow metrics over time (e.g., aggregate detection counts, calculate average confidence scores, track distinct class occurrences, compute value distributions), enabling statistical analysis and reporting for production workflows
- Model Performance Analysis: Analyze model predictions across multiple inputs (e.g., calculate average prediction counts, track distinct predicted classes, compute min/max confidence scores, count occurrences of each class), enabling comprehensive model performance evaluation and insights
- Data Stream Summarization: Summarize high-frequency data streams into periodic reports (e.g., aggregate every 60 seconds of detections into summary statistics, compute hourly averages, generate per-run summaries), enabling efficient data reduction and analysis for high-volume workflows
- Multi-Model Comparison: Aggregate results from multiple models for comparison (e.g., compare average detection counts across models, track distinct classes per model, compute aggregate statistics for model ensembles), enabling comparative analytics across different inference pipelines
Connecting to Other Blocks¶
This block receives data from workflow steps and outputs aggregated statistics periodically:
- After detection or analysis blocks (e.g., Object Detection, Instance Segmentation, Classification) to aggregate prediction results over time or across frames, enabling statistical analysis of model outputs and detection patterns
- After data processing blocks (e.g., Expression, Property Definition, Detections Filter) that produce numeric or list outputs to aggregate computed values, metrics, or transformed data over intervals
- Before sink blocks (e.g., CSV Formatter, Local File Sink, Webhook Sink) to save periodic aggregated reports, enabling efficient storage and export of summarized analytics data instead of individual data points
- In video processing workflows to generate time-based or frame-based analytics reports, enabling comprehensive video analysis with periodic statistical summaries rather than per-frame outputs
- Before visualization or reporting blocks that need aggregated data to create dashboards, charts, or summaries from time-series data, enabling visualization of trends and statistics
- In analytics pipelines where high-frequency data needs to be reduced to periodic summaries, enabling efficient downstream processing and storage of statistical insights rather than raw high-volume data streams
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/data_aggregator@v1to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
data_operations |
Dict[str, List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractFrameMetadata, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, PickDetectionsByParentClass, RandomNumber, SequenceAggregate, SequenceApply, SequenceElementsCount, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, TimestampToISOFormat, ToBoolean, ToNumber, ToString]]] |
Optional dictionary mapping variable names (from data) to UQL (Query Language) operation chains that transform data before aggregation. Operations are applied in sequence to extract, filter, or transform values (e.g., extract class names from detections using DetectionsPropertyExtract, calculate sequence length using SequenceLength, filter values, perform calculations). Keys must match variable names in data. Leave empty or omit variables that don't need transformation. Example: {'predictions': [{'type': 'DetectionsPropertyExtract', 'property_name': 'class_name'}]}.. | ❌ |
aggregation_mode |
Dict[str, List[str]] |
Dictionary mapping variable names (from data) to lists of aggregation operations to compute. Each aggregation produces an output field named '{variable_name}_{aggregation_mode}'. Supported operations: 'sum' (sum of numeric values), 'avg' (average of numeric values), 'max'/'min' (maximum/minimum numeric values), 'count' (count values, adds list length for lists), 'distinct' (list of unique values), 'count_distinct' (number of unique values), 'values_counts' (dictionary of value occurrence counts), 'values_difference' (difference between max and min numeric values). For lists, operations process each element. Multiple aggregations per variable are supported. Example: {'predictions': ['distinct', 'count_distinct', 'avg']}.. | ❌ |
interval_unit |
str |
Unit for measuring the aggregation interval: 'seconds', 'minutes', 'hours' (time-based, uses wall-clock time elapsed since last output - useful for video streams), or 'runs' (run-based, counts number of workflow executions - useful for video file processing where frame count matters more than time). Time-based intervals track elapsed time between aggregated outputs. Run-based intervals count the number of times the block receives data. The block outputs aggregated results and flushes state when the interval threshold is reached.. | ❌ |
interval |
int |
Length of the aggregation interval in the units specified by interval_unit. Must be greater than 0. The block accumulates data internally and outputs aggregated results when this interval threshold is reached. For time-based units (seconds, minutes, hours), this is the duration elapsed since the last output. For 'runs', this is the number of workflow executions (e.g., frames processed) since the last output. After outputting results, the block resets its internal state and starts a new aggregation window. Most of the time, the block returns empty outputs while collecting data.. | ❌ |
The Refs column marks possibility to parametrise the property with dynamic values available
in workflow runtime. See Bindings for more info.
Available Connections¶
Compatible Blocks
Check what blocks you can connect to Data Aggregator in version v1.
- inputs:
Google Gemini,Mask Visualization,Dimension Collapse,VLM As Detector,Identify Outliers,Single-Label Classification Model,Image Blur,Depth Estimation,Byte Tracker,Cache Set,Clip Comparison,Crop Visualization,SmolVLM2,Property Definition,Data Aggregator,Model Monitoring Inference Aggregator,Cache Get,Multi-Label Classification Model,Anthropic Claude,Keypoint Visualization,Google Gemini,Seg Preview,SORT Tracker,OpenAI,Keypoint Detection Model,Stability AI Inpainting,Perspective Correction,YOLO-World Model,Reference Path Visualization,Trace Visualization,Buffer,Grid Visualization,Polygon Visualization,Polygon Zone Visualization,Stitch OCR Detections,PTZ Tracking (ONVIF),JSON Parser,Stitch OCR Detections,CLIP Embedding Model,Continue If,SAM 3,SIFT Comparison,Detections Combine,Image Slicer,Dynamic Crop,Qwen3-VL,Byte Tracker,Distance Measurement,Image Threshold,OpenAI,SAM 3,Email Notification,Line Counter,Webhook Sink,Instance Segmentation Model,Pixel Color Count,Camera Focus,Roboflow Dataset Upload,Qwen2.5-VL,Time in Zone,Detection Offset,Keypoint Detection Model,Blur Visualization,Contrast Equalization,QR Code Generator,Dot Visualization,Background Subtraction,Roboflow Custom Metadata,Bounding Box Visualization,Relative Static Crop,S3 Sink,Polygon Visualization,Twilio SMS/MMS Notification,Camera Calibration,Detections Classes Replacement,Detections Transformation,Overlap Filter,Email Notification,Circle Visualization,Single-Label Classification Model,Object Detection Model,Detections Merge,Anthropic Claude,Path Deviation,Pixelate Visualization,Google Vision OCR,Detections Filter,Google Gemini,Path Deviation,Image Convert Grayscale,Florence-2 Model,EasyOCR,GLM-OCR,VLM As Detector,Dominant Color,Multi-Label Classification Model,Semantic Segmentation Model,Florence-2 Model,Corner Visualization,Detections Stabilizer,OC-SORT Tracker,Delta Filter,VLM As Classifier,Clip Comparison,Detections Consensus,VLM As Classifier,Triangle Visualization,Stitch Images,Expression,Llama 3.2 Vision,Stability AI Image Generation,Halo Visualization,QR Code Detection,CSV Formatter,CogVLM,Motion Detection,Detections Stitch,Detections List Roll-Up,Time in Zone,Object Detection Model,Template Matching,Identify Changes,Halo Visualization,Size Measurement,Label Visualization,Bounding Rectangle,Perception Encoder Embedding Model,Anthropic Claude,Cosine Similarity,Instance Segmentation Model,Line Counter Visualization,Slack Notification,Time in Zone,Moondream2,Stability AI Outpainting,Heatmap Visualization,Ellipse Visualization,LMM For Classification,First Non Empty Or Default,Icon Visualization,OpenAI,SIFT,Background Color Visualization,SIFT Comparison,Text Display,Velocity,Gaze Detection,LMM,Qwen3.5-VL,Image Contours,Barcode Detection,Mask Area Measurement,Dynamic Zone,Detection Event Log,Roboflow Dataset Upload,Color Visualization,Twilio SMS Notification,Absolute Static Crop,OpenAI,Byte Tracker,OCR Model,ByteTrack Tracker,SAM 3,Segment Anything 2 Model,Model Comparison Visualization,Rate Limiter,Camera Focus,Line Counter,Image Slicer,Classification Label Visualization,Image Preprocessing,Local File Sink,Morphological Transformation,Environment Secrets Store - outputs:
Google Gemini,Mask Visualization,Dimension Collapse,VLM As Detector,Identify Outliers,Single-Label Classification Model,Image Blur,Depth Estimation,Clip Comparison,Byte Tracker,Cache Set,Crop Visualization,SmolVLM2,Data Aggregator,Property Definition,Model Monitoring Inference Aggregator,Cache Get,Multi-Label Classification Model,Anthropic Claude,Keypoint Visualization,Google Gemini,Seg Preview,SORT Tracker,OpenAI,Keypoint Detection Model,Stability AI Inpainting,Perspective Correction,YOLO-World Model,Reference Path Visualization,Trace Visualization,Buffer,Grid Visualization,Polygon Visualization,Polygon Zone Visualization,Stitch OCR Detections,PTZ Tracking (ONVIF),JSON Parser,Stitch OCR Detections,SAM 3,Continue If,CLIP Embedding Model,SIFT Comparison,Detections Combine,Image Slicer,Dynamic Crop,Qwen3-VL,Byte Tracker,Distance Measurement,Image Threshold,OpenAI,Email Notification,SAM 3,Line Counter,Webhook Sink,Instance Segmentation Model,Pixel Color Count,Camera Focus,Roboflow Dataset Upload,Qwen2.5-VL,Keypoint Detection Model,Time in Zone,Detection Offset,Blur Visualization,Contrast Equalization,QR Code Generator,Dot Visualization,Background Subtraction,Roboflow Custom Metadata,Bounding Box Visualization,Relative Static Crop,S3 Sink,Twilio SMS/MMS Notification,Polygon Visualization,Camera Calibration,Detections Classes Replacement,Detections Transformation,Overlap Filter,Email Notification,Circle Visualization,Single-Label Classification Model,Object Detection Model,Detections Merge,Anthropic Claude,Path Deviation,Pixelate Visualization,Google Vision OCR,Google Gemini,Detections Filter,Path Deviation,Image Convert Grayscale,Florence-2 Model,EasyOCR,GLM-OCR,VLM As Detector,Dominant Color,Multi-Label Classification Model,Semantic Segmentation Model,Florence-2 Model,Corner Visualization,Detections Stabilizer,OC-SORT Tracker,Delta Filter,VLM As Classifier,Clip Comparison,Detections Consensus,VLM As Classifier,Triangle Visualization,Stitch Images,Expression,Llama 3.2 Vision,Stability AI Image Generation,Halo Visualization,QR Code Detection,CSV Formatter,CogVLM,Motion Detection,Detections Stitch,Detections List Roll-Up,Time in Zone,Object Detection Model,Template Matching,Identify Changes,Halo Visualization,Size Measurement,Label Visualization,Bounding Rectangle,Perception Encoder Embedding Model,Anthropic Claude,Cosine Similarity,Instance Segmentation Model,Line Counter Visualization,Slack Notification,Moondream2,Time in Zone,Stability AI Outpainting,Heatmap Visualization,Ellipse Visualization,LMM For Classification,First Non Empty Or Default,Icon Visualization,OpenAI,SIFT,Background Color Visualization,SIFT Comparison,Text Display,Velocity,Gaze Detection,Qwen3.5-VL,LMM,Image Contours,Mask Area Measurement,Barcode Detection,Dynamic Zone,Detection Event Log,Roboflow Dataset Upload,Color Visualization,Twilio SMS Notification,Absolute Static Crop,OpenAI,Byte Tracker,OCR Model,ByteTrack Tracker,SAM 3,Segment Anything 2 Model,Model Comparison Visualization,Rate Limiter,Camera Focus,Image Slicer,Line Counter,Classification Label Visualization,Image Preprocessing,Local File Sink,Morphological Transformation
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Data Aggregator in version v1 has.
Bindings
-
input
data(*): Dictionary mapping variable names to data sources from workflow steps. Each key becomes a variable name for aggregation, and each value is a selector referencing workflow step outputs (e.g., predictions, metrics, computed values). These variables are used in aggregation_mode to specify which aggregations to compute. Example: {'predictions': '$steps.model.predictions', 'count': '$steps.counter.total'}..
-
output
*(*): Equivalent of any element.
Example JSON definition of step Data Aggregator in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/data_aggregator@v1",
"data": {
"predictions": "$steps.model.predictions",
"reference": "$inputs.reference_class_names"
},
"data_operations": {
"predictions": [
{
"property_name": "class_name",
"type": "DetectionsPropertyExtract"
}
]
},
"aggregation_mode": {
"predictions": [
"distinct",
"count_distinct"
]
},
"interval_unit": "seconds",
"interval": 10
}