Query System Point Metrics (v2.0)

Query the details of the system point metrics.

application/json

Request Body

Query request for getting sysmetrics

end_time date required

The end time of the point metrics query. End times need to be specified in ISO8601 UTC format.

filter Filter required

Filters according to the specifications.

elements string[] required

Elements of the filter.

path string[] required

Path of the filter.

site object required

Site of the filter.

type string

Type of the filter.

interval string required

Possible values: [TEN_SEC, ONE_MIN, FIVE_MIN, ONE_HOUR, ONE_DAY]

The interval time.

metrics Metrics[] required
The details of the point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.
Array [
series Series[] required
Information on the series schema.
Array [
data Data[] required
Data
Array [
datapoints Datapoints[] required
Datapoints
Array [
duration date-time required
The date and time of the series.
filter_property_id string required
The filter property ID.
links string[] required
Links
sites string[] required
The sites.
value number required
The values of the filter.
]
statistics object required
Statistics
]
interval string required
The interval time.
name string required
The name.
unit string required
Unit
view object required
View the active series details.
]
]
name string required

The name of the point metric. Maz size = 128.

start_time date required

The start time to get the point metrics. Start times need to be specified in ISO8601 UTC format.

view View required

View

individual string required

Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, USER, USER_EMAIL, RESOLUTION_QUALITY, None]

The individual view values.

summary boolean required

The summary of the view.

Responses

• 200
• 400

---

Successful Operation

application/json

Schema

Example (from schema)

---

Schema

interval string required

The time period of the query interval.

metrics object required

The details of the point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.

start_time date required

The start time to get the point metrics. Start times need to be specified in ISO8601 UTC format.

view View required

The individual and summary views.

individual string required

Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, USER, USER_EMAIL, RESOLUTION_QUALITY, None]

The individual view values.

summary boolean required

The summary of the view.

{
  "interval": "string",
  "metrics": {},
  "start_time": "2023-09-23",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}

Bad Request

application/json

Schema

Example (from schema)

Example

---

Schema

_error ErrorResponse[]
Array [
code string
message string
]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "FUTURE_TIME_ERROR"
      }
    ]
  }
}

Loading...