Metrics available for the API

Prometheus and JVM metrics are provided to monitor your APIs. For more information about the metric types, see the Prometheus documentation.

JVM metrics

The standard JVM metrics are available for the API server, such as process_cpu_usage and jvm_memory_used_bytes.

The following Prometheus metrics are available for each API. You can use these to create dashboards and track the API usage.

List of available Prometheus metrics
Metric name	Description	Metric type	Labels
dataset_api_http_requests_total	Number of requests	Counter	api_path: The path to the API. api_id: The ID of the API. dataset_id: The ID of the dataset. method: The HTTP or HTTPS method used in the request, GET for example. code: The HTTP or HTTPS response code, 200 for example. action: The action performed. It can be read, read_all or count.
dataset_api_request_duration_seconds	Average duration of requests, in seconds	Histogram	api_path: The path to the API. api_id: The ID of the API. dataset_id: The ID of the dataset. method: The HTTP or HTTPS method used in the request, GET for example. code: The HTTP or HTTPS response code, 200 for example. action: The action performed. It can be read, read_all or count.

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!