APM - Mackerel API Documents (v0)

Get HTTP Server Statistics
Get Database Query Statistics

Get HTTP Server Statistics

Get HTTP server statistics that match the specified conditions from data posted via the tracing feature. Only SERVER-side HTTP requests are aggregated, and CLIENT spans are excluded.

GET /api/v0/apm/http-server-stats

Required permissions for the API key

Read

Input

This API accepts query parameters to specify conditions. The following parameters are available:

PARAM NAME	TYPE	DESCRIPTION
`serviceName`	string	[required] Service name. Corresponds to `service.name` in OpenTelemetry semantic conventions.
`serviceNamespace`	string	[optional] Service namespace. Corresponds to `service.namespace` in OpenTelemetry semantic conventions.
`from`	number	[required] Start time for retrieving statistics (Unix epoch seconds). The range between `to` is limited to 30 minutes.
`to`	number	[required] End time for retrieving statistics (Unix epoch seconds). The range between `from` is limited to 30 minutes.
`environment`	string	[optional] Environment name. Corresponds to `deployment.environment` or `deployment.environment.name` in OpenTelemetry semantic conventions.
`version`	string	[optional] Version. Corresponds to `service.version` in OpenTelemetry semantic conventions.
`method`	string	[optional] Filter by HTTP method. Corresponds to `http.request.method` or `http.method` in OpenTelemetry semantic conventions. `http.request.method` is preferred.
`route`	string	[optional] Filter by route (partial match). Corresponds to `http.route`, `url.path`, `http.target`, or `http.url` in OpenTelemetry semantic conventions. Preferred in this order.
`orderColumn`	string	[optional] Sort column. One of `SUM` (total latency), `AVERAGE` (average latency), `P95` (95th percentile latency), `ERROR_RATE` (error rate), or `REQUEST_COUNT` (request count). Default is `P95`.
`orderDirection`	string	[optional] Sort order. Either `ASC` (ascending) or `DESC` (descending). Default is `DESC`.
`page`	number	[optional] Page number (starting from 1). Default is `1`.
`perPage`	number	[optional] Number of items per page (1-100). Default is `20`.

Response

Success

{
  "results": [
    {
      "method": "GET",
      "route": "/api/users",
      "totalMillis": 837.0,
      "averageMillis": 9.01,
      "approxP95Millis": 19.89,
      "errorRatePercentage": 0.0,
      "requestCount": 93
    },
    {
      "method": "POST",
      "route": "/api/orders",
      "totalMillis": 1250.0,
      "averageMillis": 12.5,
      "approxP95Millis": 25.5,
      "errorRatePercentage": 2.5,
      "requestCount": 100
    }
  ],
  "hasNextPage": false
}

The response object has the following keys:

KEY	TYPE	DESCRIPTION
`results`	array	Array of HTTP server statistics
`hasNextPage`	boolean	Whether the next page exists

HTTP server statistics objects have the following keys:

KEY	TYPE	DESCRIPTION
`method`	string	HTTP method. Corresponds to `http.request.method` or `http.method` in OpenTelemetry semantic conventions. `http.request.method` is preferred.
`route`	string	HTTP route. Corresponds to `http.route`, `url.path`, `http.target`, or `http.url` in OpenTelemetry semantic conventions. Preferred in this order.
`totalMillis`	number	Total latency (milliseconds). Calculated from span duration (end - start)
`averageMillis`	number	Average latency (milliseconds). Average value calculated by dividing total execution time by request count
`approxP95Millis`	number	Approximate P95 latency (milliseconds)
`errorRatePercentage`	number	Error rate (%). Percentage of requests with HTTP status code 500 or higher
`requestCount`	number	Request count. Number of spans that handled HTTP requests

Error

STATUS CODE	DESCRIPTION
400	when the input is in an unacceptable format
401	when the API key is invalid
403	when the API key doesn't have the required permissions / when accessing a service that you don't have access to
429	when the API request rate limit is exceeded (1 req/sec)

Get Database Query Statistics

Get database query statistics that match the specified conditions from data posted via the tracing feature. Only CLIENT spans indicating database access are aggregated, and SERVER spans are excluded.

GET /api/v0/apm/db-query-stats