Events API

5 endpoints — authenticate with a workspace access token via Authorization: Bearer. See the API introduction for base URLs, pagination, and rate limits.

Ingest Events

POST/api/events/ingest

Ingest batch of events. **Scopes**: `events:write`

Request body `EventsIngest`

eventsEventCreateCustomer | EventCreateExternalCustomer[]required

List of events to ingest.

Returns 201 with EventsIngestResponse.

curl -X POST \
  https://api.rapidly.tech/api/events/ingest \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Get Event

GET/api/events/{id}

Get an event by ID. **Scopes**: `events:read` `events:write`

Path parameters

idstringrequired

The event ID.

Returns 200 with Event.

curl -X GET \
  https://api.rapidly.tech/api/events/{id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

List Events

GET/api/events/

List events. **Scopes**: `events:read` `events:write`

Query parameters

start_timestampstring | null

Filter events after this timestamp.

end_timestampstring | null

Filter events before this timestamp.

workspace_idstring | string[] | null

Filter by workspace ID.

customer_idstring | string[] | null

Filter by customer ID.

external_customer_idstring | string[] | null

Filter by external customer ID.

namestring | string[] | null

Filter by event name.

source"system" | "user" | "system" | "user"[] | null

Filter by event source.

querystring | null

Query to filter events.

parent_idstring | null

When combined with depth, use this event as the anchor instead of root events.

depthinteger | null

Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sorting"timestamp" | "-timestamp"[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

metadataobject | null

Filter by metadata key-value pairs using ``deepObject`` style, e.g. ``?metadata[key]=value``.

Returns 200 with PaginatedList_Event_ | CursorPaginatedList_Event_.

curl -X GET \
  https://api.rapidly.tech/api/events/ \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

List Event Names

GET/api/events/names

List event names. **Scopes**: `events:read` `events:write`

Query parameters

workspace_idstring | string[] | null

Filter by workspace ID.

customer_idstring | string[] | null

Filter by customer ID.

external_customer_idstring | string[] | null

Filter by external customer ID.

source"system" | "user" | "system" | "user"[] | null

Filter by event source.

querystring | null

Query to filter event names.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

Returns 200 with PaginatedList_EventName_.

curl -X GET \
  https://api.rapidly.tech/api/events/names \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

List statistics timeseries

GET/api/events/statistics/timeseries

Get aggregate statistics grouped by root event name over time. Returns time series data with periods and totals, similar to the metrics endpoint. Each period contains stats grouped by event name, and totals show overall stats across all periods. **Scopes**: `events:read` `events:write`

Query parameters

start_datestringrequired

Start date.

end_datestringrequired

End date.

Timezone to use for the dates. Default is UTC.

interval"year" | "month" | "week" | "day" | "hour"required

Supported aggregation granularities, ordered coarsest-first.

workspace_idstring | string[] | null

Filter by workspace ID.

customer_idstring | string[] | null

Filter by customer ID.

external_customer_idstring | string[] | null

Filter by external customer ID.

namestring | string[] | null

Filter by event name.

source"system" | "user" | "system" | "user"[] | null

Filter by event source.

event_type_idstring | null

Filter by event type ID.

querystring | null

Query to filter events.

aggregate_fieldsstring[]

Metadata field paths to aggregate (e.g., '_cost.amount', 'duration_ns'). Use dot notation for nested fields.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

metadataobject | null

Filter by metadata key-value pairs using ``deepObject`` style, e.g. ``?metadata[key]=value``.

Returns 200 with ListStatisticsTimeseries.

curl -X GET \
  https://api.rapidly.tech/api/events/statistics/timeseries \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

Events API

Ingest Events

Request body EventsIngest

Get Event

Path parameters

List Events

Query parameters

List Event Names

Query parameters

List statistics timeseries

Query parameters

Request body `EventsIngest`