Get total count of events

Returns the count of unique values (cardinality) for a specified field within a defined time range. This endpoint allows you to quantify the diversity of your event data such as counting unique users, distinct error types, or total event volume, while applying filters to narrow the scope.

Path Params
string
required

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

Query Params
filters
object

To use the filter builder, you must first select a single top-level logic group (AND/OR) and then add your filter conditions within the group. All conditions in the group are evaluated together using the group's logic operator (AND/OR).

Do not include both operator types at the top-level. If you need to combine AND/OR logic, you can switch the logic type by adding a new nested group object within the first group, such as AND[user is Bob, OR[severity is high, severity is low]]. This translates to "user is Bob AND (severity is high OR severity is low)".

Note that you can also send the filter object as a JSON-encoded string. Ensure your JSON follows the same structure as the query builder.

number
required

Return events starting from the specified time in epoch timestamp (milliseconds).

number
required

Return events up to the specified time in epoch timestamp (milliseconds).

string
enum
required

The event attribute to aggregate for unique values. You can use uuid to calculate the total number of unique events.

Responses

400

Bad Request

401

Unauthorized - Invalid or missing authentication token

403

Forbidden: Access to this resource is denied

500

Internal Server Error - Unexpected server error

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json