Skip to main content
GET
/
system
/
metric
/
{name}
Get a metric's data
import requests

url = "https://{FUSION HOST}/api/system/metric/{name}"

response = requests.get(url)

print(response.text)
{
  "metricRegistry": {
    "metrics": {},
    "names": [
      "<string>"
    ],
    "gauges": {},
    "counters": {},
    "histograms": {},
    "meters": {},
    "timers": {}
  },
  "metricsList": {},
  "pretty": true,
  "rateUnit": "NANOSECONDS",
  "durationUnit": "NANOSECONDS",
  "showSamples": true
}

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
​
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