Metrics

Returns a list of metrics that have been created.

get/metrics

Request

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

Query parameters

Pageinteger

Page number your requesting

PageSizeinteger

Number of rows your requesting

Filters[]unknown

FilterBy = (Name | UCK); Op = (contains | does_not_contain | matches_exactly | starts_with | ends_with); Value: string;

Sorting[]unknown

SortBy = (ID | Name | UCK); Direction = (DESC | ASC);

Response

Success

Successboolean

Example response

{
  "Success": true,
  "Data": {
    "Success": true,
    "Data": [
      {
        "ID": 1,
        "Name": "Active Directory: User Password & Activity Summary [Power BI]",
        "Description": "Information related to user password settings and activity, designed to be pulled into Power BI for reporting.",
        "CreatedOn": "2018-02-01T18:31:22.896Z",
        "UpdatedOn": "2018-02-01T18:31:22.896Z",
        "InspectorID": 1,
        "ServiceProviderID": 1,
        "EnvironmentID": 1,
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "UCK": "Active Directory: User Password & Activity Summary [Power BI] - 26c53894f6af4b1ab2ca550e0f20f76d",
        "Enabled": true,
        "Visible": true,
        "UUID": "Active Directory: User Password & Activity Summary [Power BI] - 26c53894f6af4b1ab2ca550e0f20f76d",
        "MetricVersions": [
          {
            "ID": 1,
            "InspectorVersionID": 2,
            "Query": "Users[].{BadLogonCount: BadLogonCount, DaysSinceLastLogin: DaysSinceLastLogin, DaysSinceLastPasswordChange: DaysSinceLastPasswordChange, LockedOut: LockedOut, PasswordNeverExpires: PasswordNeverExpires, PasswordNotRequired: PasswordNotRequired, Privileged: Privileged, UserActivity: UserActivity, UserName: UserName, LastLogonDate: LastLogonDate, CreateTime: CreateTime}"
          }
        ],
        "MetricDisplay": true,
        "ChangesEnabled": true,
        "Inspector": [
          {
            "ID": 13,
            "Name": "active-directory-inspector",
            "Alias": "Active Directory",
            "Published": true,
            "Author": "Liongard, Inc.",
            "ContactEmail": "support@liongard.com",
            "Logo": "https://resources.static.liongard.com/images/active-directory-inspector.png",
            "Icon": "https://resources.static.liongard.com/images/icons/microsoft-windows-icon.png",
            "Description": "Inspects Active Directory, returning a wide variety of data including actionable summary information such as privileged users, security policies and much more.",
            "HelpLink": "https://docs.liongard.com/docs/active-directory-inspection-setup",
            "PublishedStatus": "production",
            "InspectorCategory": "appservices",
            "DefaultFrequency": {
              "Type": "days",
              "Interval": 1
            },
            "Constraints": {
              "Tiers": [
                "core"
              ],
              "Platform": [
                "windows"
              ],
              "Frequency": {
                "MaxIntervalType": "hours",
                "MaxIntervalFrequency": 8
              },
              "AgentConstraint": [
                "customer-on-prem"
              ],
              "RecomendedAgent": "customer-on-prem"
            },
            "CreatedOn": "2021/09/10 19:21:03",
            "UpdatedOn": "2021/09/10 19:21:03"
          }
        ]
      }
    ]
  }
}

Changes

    • warning

      deleted the query request parameter conditions[]

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id Metrics removed and replaced with

    • info

      added the new optional query request parameter Filters[]

    • info

      added the new optional query request parameter Page

    • info

      added the new optional query request parameter PageSize

    • info

      added the new optional query request parameter Sorting[]

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status