Skip to main content
POST
Query realized action savings

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

Aggregate the savings actions have realized, day by day.

Rows are already scoped to the teams the caller may see. To narrow further to specific teams, filter on the team_id dimension.

measures
(SemiStructuredMeasure[DailyActionSavingsDimensions] · object | enum<string>)[]

Aggregates to compute over the matching rows.

dimensions
(SemiStructuredDimension[DailyActionSavingsDimensions] · object | enum<string>)[]

Columns to group the aggregates by. Each is returned on every row.

filter_expression
FilterExpression[Union[SemiStructuredDimension[DailyActionSavingsDimensions], DailyActionSavingsDimensions]] · object | null

An and/or tree of predicates over dimensions, applied before aggregation. Omit to match every row the caller can see.

measure_filters
(InFilter[DailyActionSavingsMeasures] · object | ArrayContainsFilter[DailyActionSavingsMeasures] · object | IsFilter[DailyActionSavingsMeasures] · object | LikeFilter[DailyActionSavingsMeasures] · object | MultiLikeFilter[DailyActionSavingsMeasures] · object | EqFilter[DailyActionSavingsMeasures] · object | FilterExpression[DailyActionSavingsMeasures] · object | InRelativeDateRangeFilter[DailyActionSavingsMeasures] · object)[]

Predicates over measures, applied after aggregation.

sort
Sort[DailyActionSavingsMeasures, DailyActionSavingsDimensions] · object[]

Ordering applied to the aggregated rows.

limit
integer
default:1000

Maximum rows to return, at most 10000. An aggregation that produces more rows than this is silently cut short at the limit, so narrow the filters or group by fewer dimensions rather than raising it to see everything.

Required range: 1 <= x <= 10000
return_sql
boolean
default:false

Return the SQL that produced the rows alongside them, for inspecting how a result was computed. Not every query endpoint publishes its SQL; where it does not, the field stays null.

Response

Successful Response

items
Items · object[]
required
page_token
string | null

Opaque cursor for the next page; empty/absent on the last page.

row_count
integer | null

Best-effort total for the filtered result set; may be null when expensive.

sql
string | null

The SQL that produced these rows, returned only when the request asks for it. Database and schema names are left as placeholders. Null when the request did not ask for it, or when this endpoint does not publish its SQL.