Skip to main content

15.1.5.2 Metrics API

MetricsResourceApi queries real-time observability metrics for the IDMP service.

Method List

Java MethodPython MethodHTTPDescription
apiV1ObservabilityMetricsGetapi_v1_observability_metrics_getGET /api/v1/observability/metricsQuery real-time observability metrics

Query Real-Time Observability Metrics

Returns real-time observability metrics for the IDMP service.

Parameters

NameTypeRequiredDescription
metricCodesstringNoFilter by metric code; omit to query all available metrics

Returns: MetricsDTO

Example

MetricsResourceApi metricsApi = apiClient.buildClient(MetricsResourceApi.class);
MetricsDTO result = metricsApi.apiV1ObservabilityMetricsGet(null);
System.out.println(result);

note

The 2.0.0.10 SDK has no MetricResourceApi or methods for metric history, latest values, or writing metric data. Do not use the api_v1_metrics_* methods from earlier documentation.

note

For the complete method signatures and parameters, refer to the OpenAPI spec file (idmp-v{{VERSION}}.json) included in the SDK package, or browse the Swagger UI at /swagger-ui.html on your IDMP server.