Skip to main content
GET
/
system
/
metric
/
{name}
Error
A valid request URL is required to generate request examples
{
  "metricRegistry": {
    "metrics": {},
    "meters": {},
    "names": [
      "<string>"
    ],
    "counters": {},
    "timers": {},
    "histograms": {},
    "gauges": {}
  },
  "metricsList": {},
  "pretty": false,
  "showSamples": false
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
name
string
required

The name of the metric to display

Query Parameters

​
pretty
boolean

True to format the data for easier reading

​
rateUnit
string

The time unit ('seconds', 'minutes', and so on) to display rates

​
durationUnit
string

The time unit ('seconds', 'minutes', and so on) to display durations

​
showSamples
boolean

True to display the data values used in calculations

Response

200 - application/json

successful operation

​
metricRegistry
object
​
metricsList
object
​
pretty
boolean
default:false
​
rateUnit
enum<string>
Available options:
NANOSECONDS,
MICROSECONDS,
MILLISECONDS,
SECONDS,
MINUTES,
HOURS,
DAYS
​
durationUnit
enum<string>
Available options:
NANOSECONDS,
MICROSECONDS,
MILLISECONDS,
SECONDS,
MINUTES,
HOURS,
DAYS
​
showSamples
boolean
default:false