Sign in

v1

latestOpenAPI 3.0.02026-07-249372139.7 KB
Metrics

Get Metric Values for all systems

Returns Metric values for all systems from the provided Metric ID/UUID(s).

Rate Limit: Requests from a single user in excess of 100 requests per minute may be throttled.

While its not required to specify filter or sorting objects, it is required to include an empty array in the request.

post/metrics/evaluate

Query parameters

includeNonVisibleboolean

Determines if metrics set to display off will be evaluated, default is false. Set to true if you would like to evaluate all metrics regardless if enabled or not

Request body

Example request

{
  "Metrics": [
    "uuid"
  ],
  "Sorting": [
    {
      "SortBy": "EnvironmentName"
    }
  ],
  "Pagination": {
    "Page": 1,
    "PageSize": 25
  }
}

Response

Success

Successboolean

Example response

{
  "Success": true,
  "Data": [
    {
      "FriendlyName": "Active Directory - Contoso",
      "InspectorName": "active-directory-inspector",
      "EnvironmentName": "Contoso Nation",
      "MetricUUID": "aa4eef4d-3dc5-4b3d-9d8a-00c1d9b68065",
      "MetricName": "Active Directory: Count of Joined Computers",
      "TimelineDate": "2021-07-21T14:52:57.022Z",
      "Value": 5
    }
  ],
  "Pagination": {
    "TotalRows": 1,
    "CurrentPage": 1,
    "TotalPages": 1,
    "PageSize": 25
  }
}