Get Super Metrics

Get Super Metrics

Get a collection of SuperMetrics based on search parameters

Request
URI
GET
https://{api_host}/suite-api/api/supermetrics
COPY
Query Parameters
string of array
id
Optional

SuperMetrics based on identifiers

string of array
name
Optional

SuperMetrics based on names

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

Authentication
This operation uses the following authentication methods.
Responses
200

The SuperMetrics for the given query

Returns supermetrics of type(s) application/json 
"{\n  \"superMetrics\" : [ {\n    \"id\" : \"54e94ebb-498e-4d52-ad14-01cac5446b8f\",\n    \"name\" : \"Example SuperMetric for DataCenter\",\n    \"formula\" : \"sumN(\\\\$This:cpu|demandmhz,2)\",\n    \"description\" : \"Sum the CPU usage in MHZ on the assigned resource and its children\"\n  }, {\n    \"id\" : \"1e09849a-2cab-44a4-97c6-1e86b0a3bacb\",\n    \"name\" : \"Example SuperMetric for DataCenter\",\n    \"formula\" : \"sumN(\\\\$This:cpu|demandmhz,2)\",\n    \"description\" : \"Sum the CPU usage in MHZ on the assigned resource and its children\"\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
superMetrics
Optional

Model object that represents a SuperMetric


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/supermetrics
On This Page
Super Metrics Operations
GET
Get Super Metrics
PUT
Update Super Metric
POST
Create Super Metric
GET
Get Super Metric
DELETE
Delete Super Metric