Execute query
POST/v2/illuminate/queries/execute
Executes a query definition without saving it. Use this to preview results before creating a saved query, dashboard, or decision.
Pipeline structure
The query pipeline follows a three-stage model:
- Sources — Define where data comes from (
businessObjectorreference). Each source specifies fields, time ranges, and filters. - Transforms — Optional processing steps:
aggregate,window,join,dedupe,calculate,unnest,filter_join. Each transform references aninput(a sourceidor previous transformid). - Output — Specifies which stage to return results from (
from), which fields toselect, sorting (orderBy), and pagination (limit/offset).
Conditional requirements
| Field | Condition |
|---|---|
source.businessObjectId | Required when source.type is businessObject |
source.referenceId | Required when source.type is reference |
timeRange.relative / timeRange.absolute | Mutually exclusive — specify only one |
Request
Example
{
"data": [
{}
],
"executionTime": 37,
"queryDefinition": {
"version": "2.0",
"pipeline": {
"sources": [
{}
],
"transforms": [
{}
],
"output": {
"from": "event_aggregation",
"select": [],
"orderBy": [],
"limit": 100,
"offset": 0
}
},
"meta": {}
}
}