latestOpenAPI 3.0.32026-08-185644172.3 KB

45caf50be25e

apm

Search APM hotspots

Returns a paged ranking of APM methods, database queries, or external API calls by average duration, total duration, or call count, with an optional minimum average-duration threshold.

post/applications/{application-identifier}/apm/hotspots/search

Request body

startstring date-time required

Start of the hotspot analysis window.

endstring date-time required

Exclusive end of the hotspot analysis window. The window cannot exceed 30 days.

type'method' | 'query' | 'externalApi' required

The hotspot category to rank.

querystring nullable

Optional call-name text with at most 20 whitespace-separated terms. Every term must occur in the call name.

minimumAverageDurationMillisecondsinteger nullable

Optional minimum aggregate average duration in milliseconds. Only hotspots whose average call duration meets or exceeds this threshold are returned.

offsetinteger

Zero-based result offset.

countinteger

Maximum hotspots to return.

sortBy'averageDuration' | 'totalDuration' | 'callCount'

Metric used to rank hotspots.

Response

OK

startstring date-time required

The start of the analyzed window, in UTC.

endstring date-time required

The exclusive end of the analyzed window, in UTC.

isTruncatedboolean required

Whether more matching hotspots may exist beyond the requested count.

offsetinteger required

The zero-based offset of this page.

countinteger required

The number of hotspots returned in this page.

hasMoreboolean required

Whether another page of matching hotspots is available.