Get Super Metrics Using GET

Get Super Metrics Using GET

Get a collection of SuperMetrics based on search parameters

Request
URI
GET
https://{api_host}/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

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

integer
pageSize
Optional

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
{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "superMetrics": [
        {
            "description": "string",
            "formula": "string",
            "id": "string",
            "modificationTime": "string",
            "name": "string"
        }
    ]
}
array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result

superMetrics
Optional

superMetrics