Data Metrics (deprecated)

GET API metrics

GET /metrics/{apitype}

Operation ID: API metrics. Tags: metrics. Security: oauth2_application.

The metrics resource provides insights into runtimes of individual OCAPI requests against the shop or the data-API. Responses of the metrics resource are JSON wrapped metrics in Prometheus Exposition format. For each OCAPI resource, following metrics are available for the given dimension and the current time-frame (1-minute averages).

• average time of a request (p50 and p95 timings are available under the quantile dimension) in milliseconds

• minimum time of all requests in milliseconds

• maximum time of all requests in milliseconds

• m1-rate, or the one-minute-rate of requests in operations / second

Refer to the documentation of the response document for a detailed description of the metrics and dimensions exposed by this API.

This endpoint may return the following faults:

• 400 - TooManyRequestsException - Too many requests.
• 403 - FeatureNotEnabledException - Feature not enabled.

Parameters

• apitype (path, string, required) Type of the api. Values are data or shop .
  Minimum length: 1.
• offset (query, integer (int32)) Optional offset of the result set not counting commentaries or empty lines.
  Minimum: 0.
• limit (query, integer (int32)) Optional limit of the result set not counting commentaries or empty lines.
  Minimum: 1. Maximum: 4500.

Responses

• 400 TooManyRequestsException - Too many requests.

  Media type: application/json, text/xml. Schema: fault.

• 403 FeatureNotEnabledException - Feature not enabled.

  Media type: application/json, text/xml. Schema: fault.

• default

  Media type: application/json, text/xml. Schema: metric_response.