HomeLiongardRequest a DemoKnowledge Base
API Reference

Working with the Metric API

Evaluating Metrics

Liongard's Metric evaluations can be found in Liongard's API.

Liongard's Metrics allow you to extract key pieces of information from your Liongard instance. The API endpoint allows you to select up to 10 systems you would like to evaluate Metrics against. You have the option to either pass Metric IDs or Metric UUIDs as the evaluation parameters.

  • You can pull a list of System IDs from this endpoint.
  • You can pull a list of Metric ID/UUIDs from this endpoint.

From here, you can build a set of Systems and Metrics you would like to evaluate against. This endpoint will always use the latest successful inspection for its evaluations.

UUID Key vs. ID Key

UUID Key

UUID is the Universally Unique Identifier key assigned to every Metric. Every Metric created, whether Liongard-created or user-created, has a unique key, UUID.

ID Key

ID is the integer value assigned to a Metric upon its creation. This ID is created based on when the Metric is added to the specific Liongard Instance. Thus, the ID of a Metric can vary between instances.

Use Cases

Depending on your use case for integrating to Lionagard's API, a different key may be recommended to use.

Liongard Partner Integration

When building an integration to your Liongard instance, you can build to whatever key (UUID or ID) that is easiest to use in your scenario.

As new Metrics are added to your instance (Liongard-created or user-created), they will be assigned a new ID number in ascending order. If you would like to reference the UUID, these keys are generated for each Metric and do not follow any ascending or descending order.

Vendor/External Integration

If you are a Vendor building an integration to Liongard, we recommend building your integration to reference the Metric UUID. This will guarantee you are getting a unique identifier for the Metric between various partners instances and it will avoid any breaking changes if a Metric is renamed.

Below you can see an example response from a Metric and the UUID assigned to the Metric.

{
        "ID": 144,
        "Name": "Email - MX Record",
        "UUID":"aa4eef4d-3dc5-4b3d-9d8a-00c1d9b68065",
        "UCK": "Email - MX Record",
        "Description": "",
        "CreatedOn": "2019-08-13T14:53:22.080Z",
        "UpdatedOn": null,
        "ServiceProvider": {
            "ID": 1,
            "Name": "Liongard MSP"
        },
        "Environment": null,
        "Inspector": {
            "ID": 2,
            "Name": "domain-inspector",
            "Alias": "Internet Domain/DNS",
            "Published": true,
            "Author": "Liongard, Inc.",
            "ContactEmail": "[email protected]",
            "Logo": "https://resources.static.liongard.com/images/domain-inspector.png",
            "Icon": "https://resources.static.liongard.com/images/icons/domain-name-icon.png",
            "Description": "Inspects a public Internet domain, returning a wide variety of data including DNS records with MX information, registration, and expiration data.",
            "HelpLink": "https://docs.liongard.com/docs/internet-domain-dns",
            "PublishedStatus": "production",
            "InspectorCategory": "cloud",
            "EnhancedBilling": false,
            "DefaultFrequency": {
                "Type": "days",
                "Interval": 1
            },
            "Constraints": {
                "Tiers": [
                    "essential",
                    "core"
                ],
                "Platform": [
                    "linux"
                ],
                "Frequency": {
                    "MaxIntervalType": "hours",
                    "MaxIntervalFrequency": 4
                },
                "AgentConstraint": [
                    "managed-hosted",
                    "managed-ondemand"
                ]
            },
            "CreatedOn": "2021-03-23T20:48:38.234Z",
            "UpdatedOn": null,
            "DiagnosticsEnabled": false
        },
        "MetricDisplay": true,
        "ChangesEnabled": true,
        "CreatedBy": {
            "ID": 259,
            "FirstName": "Liongard",
            "LastName": "User",
            "Username": "liongardl"
        },
        "MetricVersions": [
            {
                "ID": 91,
                "InspectorVersionID": 17,
                "Query": "SystemInfo.DNSMXRecord"
            }
        ],
        "Rules": [],
        "HasActiveAlertRule": false,
        "BelongsToChangeRule": false
    }

👍

Next