LIliongard
Metrics

Fetch Metric values for one or more systems

For each system ID passed, evaluates each metric ID/UUID passed for that system for the latest inspection data and returns the results. Instead of the latest inspection data, you can specify a date from which to retrieve metric values. Setting includeNonVisible true allows you to get metric values without requiring you to toggle metrics to display within the Liongard UI.

post/metrics/bulk

Request

  • Base URL
    https://example.app.liongard.com/api/v1
  • URL
    https://example.app.liongard.com/api/v1/metrics/bulk
  • Auth
    API key in header X-ROAR-API-KEY

Query parameters

includeNonVisibleboolean

If you want to include non-enabled metrics to be evaluated. Default is false.

Request body

systemsinteger[]

List of system IDs

metricsinteger[]

List of metric IDs

metricUUIDsstring[]

List of metric UUIDs

datestring date

Inspection date from which to retrieve metric values. If not specified, metric values from the latest inspection will be retrieved.

Response

Returns a JSON object. The top level key corresponds to the system ID. Within each system, each key corresponds to a metric evaluation object, which contains information about which timeline entry was returned and what the metric evaluated to.

Example response

{
  "systemID": {
    "metricID": {
      "TimelineID": 1332180,
      "TimelineFinishedAt": "2021-09-10T19:21:03.195Z",
      "TimelineCreatedAt": "2021-09-10T19:21:03.195Z",
      "Metric": {
        "ID": 1,
        "Name": "Active Directory: Count of Joined Computers"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.