Skip to main content
POST
Query actions by dimension and measure

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

An aggregate query over actions.

Group with dimensions, aggregate with measures, narrow rows with filters or filter_expression, and narrow aggregates with measure_filters. To restrict results to a team, filter on the team_id dimension.

measures
(SemiStructuredMeasure[ActionDimensionName] · object | enum<string>)[]
dimensions
(SemiStructuredDimension[ActionDimensionName] · object | enum<string>)[]
filters
(InFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | ArrayContainsFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | IsFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | LikeFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | MultiLikeFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | EqFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | FilterExpression[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | InRelativeDateRangeFilter[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object)[]
filter_expression
FilterExpression[Union[SemiStructuredDimension[ActionDimensionName], ActionDimensionName]] · object | null
measure_filters
(InFilter[ActionMeasureName] · object | ArrayContainsFilter[ActionMeasureName] · object | IsFilter[ActionMeasureName] · object | LikeFilter[ActionMeasureName] · object | MultiLikeFilter[ActionMeasureName] · object | EqFilter[ActionMeasureName] · object | FilterExpression[ActionMeasureName] · object | InRelativeDateRangeFilter[ActionMeasureName] · object)[]
sort
Sort[ActionMeasureName, ActionDimensionName] · object[]
limit
integer
default:10000

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

Response

Successful Response

Aggregated action rows, each keyed by the requested dimensions and measures.

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.