Metrics Get Gateway Status Series

Metrics Get Gateway Status Series

Fetch health metric time series given a target gateway, time interval and list of metrics. On success, this method returns an array of time series, one per metric.

Privileges required:

READ GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/metrics/getGatewayStatusSeries
COPY
Request Body

Show optional properties

{
    "gatewayId": 0
}
{
    "gatewayId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": "gateway_metrics Object"
}
integer
gatewayId
Required

gatewayId

interval
Optional

interval

metrics
Optional

metrics

Responses
200

Request was successfully processed

Returns get_gateway_status_metrics_time_series_result of type(s) application/json
"get_gateway_status_metrics_time_series_result Object"
array of object
series
Required

series


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"gatewayId:"integer"}' https://{api_host}/portal/rest/metrics/getGatewayStatusSeries