Get TopN data with metrics output (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/aiops/topn

Get TopN sites or circuits based on growth. Note

• Start and end time need to be specified in ISO8601 UTC format.
• Metrics need to specified according to 2.0 specifications.
• Filters need to be specified according to the specifications.

Request

Path Parameters

tenant_id stringrequired

Tenant Id

application/json

Body

Query request for getting TopN Sites/Apps based on growth

end_time date

The end time to get the top n sites/apps. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.

name string

The name of the of the top n sites/apps.

start_time date

The start time to get the top n sites/apps. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

top_n TopNGrowthrequired

The details of the limit and type of the Top N reports.

compare TopNComparator

The topn n comparator metrics.

end_time date

The end date to get the top n sites/apps. Start and end time need to be specified in ISO8601 UTC format.

measurement string

Possible values: [value, value_growth, value_reduction, percentage_growth, percentage_reduction]

The measurement values of the Top N reports.

start_time date

The start date to get the top n sites/apps. Start and end time need to be specified in ISO8601 UTC format.

filter TopNGrowthFilter

Filters according to the specifications.

app string[]

Filter by apps.

direction string[]

Possible values: [Ingress, Egress]

Filter by the direction of the traffic.

element string[]

Filter by element.

path string[]

Filter by path.

path_type string[]

Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

Filter by path type. Maximum number of allowed path types is 10.

site string[]

Filter by site. Max size = 10.

waninterface string[]

Filter by wan interfaces. Max size = 10.

limit integer

The query limit.

metrics Metricsrequired

The topn n metrics. Metrics need to specified according to 2.0 specifications.

series Series[]

Information on the series schema.

Array [

data Data[]

Data

Array [

datapoints Datapoints[]

Datapoints

Array [

duration date-time

The date and time of the series.

filter_property_id string

The filter property ID.

links string[]

Links

ninetieth_percentile number

Ninetieth Percentile

sites string[]

The sites.

value number

The values of the filter.

]

statistics object

Statistics

]

interval string

The interval time.

name string

The name.

unit string

Unit

view object

View the active series details.

]

type stringrequired

Possible values: [app, site]

The type of top n metrics.

Responses

200

Successful Operation

application/json

Schema

Schema

end_time date

The end time to get the top n sites/apps. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.

name string

The name of the of the top n sites/apps.

start_time date

The start time to get the top n sites/apps. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

top_n TopNGrowthrequired

The details of the limit and type of the Top N reports.

compare TopNComparator

The topn n comparator metrics.

end_time date

The end date to get the top n sites/apps. Start and end time need to be specified in ISO8601 UTC format.

measurement string

Possible values: [value, value_growth, value_reduction, percentage_growth, percentage_reduction]

The measurement values of the Top N reports.

start_time date

The start date to get the top n sites/apps. Start and end time need to be specified in ISO8601 UTC format.

filter TopNGrowthFilter

Filters according to the specifications.

app string[]

Filter by apps.

direction string[]

Possible values: [Ingress, Egress]

Filter by the direction of the traffic.

element string[]

Filter by element.

path string[]

Filter by path.

path_type string[]

Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

Filter by path type. Maximum number of allowed path types is 10.

site string[]

Filter by site. Max size = 10.

waninterface string[]

Filter by wan interfaces. Max size = 10.

limit integer

The query limit.

metrics Metricsrequired

The topn n metrics. Metrics need to specified according to 2.0 specifications.

series Series[]

Information on the series schema.

Array [

data Data[]

Data

Array [

datapoints Datapoints[]

Datapoints

Array [

duration date-time

The date and time of the series.

filter_property_id string

The filter property ID.

links string[]

Links

ninetieth_percentile number

Ninetieth Percentile

sites string[]

The sites.

value number

The values of the filter.

]

statistics object

Statistics

]

interval string

The interval time.

name string

The name.

unit string

Unit

view object

View the active series details.

]

type stringrequired

Possible values: [app, site]

The type of top n metrics.

Example (from schema)

{
  "end_time": "2024-04-25",
  "name": "string",
  "start_time": "2024-04-25",
  "top_n": {
    "compare": {
      "end_time": "2024-04-25",
      "measurement": "value",
      "start_time": "2024-04-25"
    },
    "filter": {
      "app": [
        "string"
      ],
      "direction": [
        "Ingress"
      ],
      "element": [
        "string"
      ],
      "path": [
        "string"
      ],
      "path_type": [
        "public_direct"
      ],
      "site": [
        "string"
      ],
      "waninterface": [
        "string"
      ]
    },
    "limit": 0,
    "metrics": {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2024-04-25T18:28:29.845Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "ninetieth_percentile": 0,
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    },
    "type": "app"
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

Loading...