Skip to main content
POST
List the top events of event groups
For how the results are ranked and trimmed, see Querying traces.

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>

Body

application/json

Query for the event group list.

site_id
string
required

Site to fetch events for, as a BSON ObjectId.

from
string<date-time>
required

Start of the time range, rounded down to the start of its resolution bucket.

to
string<date-time>
required

End of the time range (inclusive). Capped at now, then rounded up to the end of its resolution bucket; MINUTELY stops at the end of the minute 2 minutes ago.

groups
string[]
required

Event groups to include (e.g. ["active_record", "moped"]). At least one.

resolution
null | enum<string>

Sets how from and to are rounded. MINUTELY fits ranges of up to 12 hours within the last 2 days; when absent or unfit, MINUTELY is used if it fits, otherwise HOURLY.

Available options:
HOURLY,
MINUTELY,
DAILY
order
enum<string>
default:IMPACT

Field to rank and truncate by.

Available options:
IMPACT,
MEAN,
THROUGHPUT
limit
integer<int32>
default:1000

Maximum number of rows to return. Clamped to 1–1000.

Response

Up to limit events across all requested groups, ranked by order descending. Some events are left out after ranking (transaction boundaries, and events without metadata or a group), so fewer rows than limit can come back.

digest
string
required

Digest identifying the event.

group
string
required

Group the event belongs to (e.g. active_record), derived from name.

name
string
required

Event name (e.g. sql.active_record).

count
integer<u-int64>
required

Number of occurrences in the time range.

Required range: x >= 0
mean
number<double>
required

Weighted mean duration in milliseconds.

impact
number<double>
required

Total time spent in milliseconds (count * mean).

title
string | null

Human-readable title.

body
string | null

Event body (e.g. the query text).