List APM services with RED metrics

Beta — may change; breaking changes are coordinated with affected
customers. Suitable for evaluation, not production reliance.

Lists services, one row per service, each carrying a closed RED metrics
snapshot under redMetrics. Filters are exact-match on serviceName,
environment, serviceNamespace, and serviceType; an omitted filter
matches every value of that dimension. Omit serviceType to return
every catalog type (Service, Database, Messaging). External
values are not catalog types (400).
When serviceType is omitted and
serviceName is set, the name matches service.name OR peer.db.name
OR peer.messaging.system.

When expand=true, each row's redMetrics.series[] additionally
carries a per-bucket time series across the query window; read the
bucket cadence from the spacing between consecutive
series[].timestamp. When expand is false or omitted, series is
absent (not null, not an empty array).

Zero matches return 200 with services: [] and meta.totalCount: 0.
meta.totalCount is -1 when an exact count is too expensive to
compute; in that case paginate by advancing offset until a page
shorter than limit is returned.

Response size grows with the number of rows on the page and, when
expand=true, with the number of series points per row. A wide window
combined with expand=true can therefore make a single page exceed the
server response-size limit and return 413 PayloadTooLarge. Recover by
narrowing the time window or requesting a smaller limit. limit is
never rejected for being too large: it is clamped to its maximum
server-side, and to a lower maximum when expand=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

OTel service.name. Single-value exact-match filter; omit (or pass an
empty value) to match services with any service.name.

string

OTel deployment.environment. Single-value exact-match filter; omit (or
pass an empty value) to match services in any environment.

string

OTel service.namespace. Single-value exact-match filter; omit (or pass
an empty value) to match services in any namespace.

string

Single-value exact-match catalog type filter for health and
/v1/apm/services. Omit (or pass an empty value) to match every catalog
type. Allowed values are Service, Database, and Messaging;
MessageBroker and Message Broker are accepted as aliases for
Messaging. All, external types, and unknown values are not accepted
(400).

date-time

RFC3339 window start (inclusive). The query window is [startTime, endTime). The two bounds are independent: omit startTime and it
defaults to endTime − 1h; omit endTime and it defaults to now;
omit both for the last hour. startTime must be earlier than
endTime, otherwise BadRequest.

date-time

RFC3339 window end (exclusive). Defaults to now when omitted. Pairs with
startTime to form the [startTime, endTime) window; see startTime
for the full defaulting rule.

boolean
Defaults to false

Endpoint-specific opt-in. On /v1/apm/services, expand=true populates
redMetrics.series[] on every row.

int64
1 to 100000
Defaults to 100

Max items per page. Default 100, range [1, 100000].

int64
≥ 0
Defaults to 0

Items to skip before the page starts. Default 0.

string
enum
Defaults to serviceName

Sort key (single key; leading - for descending).
Default: serviceName. Allowed: serviceName, environment,
serviceNamespace, invocationRatePerSecond, errorRatePerSecond,
durationP95Seconds (and their - descending forms). Sorts on
row-level scalars only — does not affect series order. Ties on the
primary key are broken by serviceName ascending for deterministic
pagination.

Responses

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