v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Segmentation

Numerically Sum

Sums an expression for events per unit time. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

get/segmentation/sum

Query parameters

project_idinteger required

Required if using service account to authenticate request.

workspace_idinteger

The id of the workspace if applicable.

eventstring required

The event that you wish to get data for. Note: this is a single event name, not an array.

from_datestring required

The date in yyyy-mm-dd format to begin querying from. This date is inclusive.

to_datestring required

The date in yyyy-mm-dd format to query to. This date is inclusive.

onstring required

The expression to sum per unit time. The result of the expression should be a numeric value. If the expression is not numeric, a value of 0.0 is assumed. See the expressions section below.

unit'hour' | 'day'

This can be "hour" or "day". This determines the buckets into which the property values that you segment on are placed. The default value is "day".

wherestring

An expression to filter events by. See the expression to segment below.

Response

Success.

statusstring
computed_atstring
resultsobject