Get Top N Data (v3.0)

POST 
/v3.0/api/tenants/:tenant_id/monitor/topn

List all the top N data.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Filter for top N

end_time date

The end time to get the Topn N reports. The time period for the Topn N reports is usually for a week.

filter AppStatsTopNFilter

Details of the filter used in this query.

app string[]

Filter by apps.

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.

site string[]

Filter by site.

waninterface string[]

The WAN interface of the network.

name string

The name of the Top N report. Maz size = 128.

start_time date

The start time to get the Topn N reports. The time period for the Topn N reports is usually for week.

top_n AppStatsTopNViewrequired

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

limit integer

The limit of the Top N reports.

type stringrequired

Possible values: [app, site]

The type of Top N reports.

topn_basis stringrequired

Possible values: [traffic_volume, transaction_failure, initiation_failure, tcp_flow, udp_flow, audio_traffic_volume, video_traffic_volume, ingress_audio_pkt_loss, egress_audio_pkt_loss, ingress_video_pkt_loss, egress_video_pkt_loss, ingress_audio_jitter, egress_audio_jitter, ingress_video_jitter, egress_video_jitter, ingress_audio_mos, egress_audio_mos]

The basis of the Top N reports.

Responses

200

Successful Operation

application/json

Schema

Schema

top_n AppStatsTopNResponseData

The details of the Top N reports.

end_time string

The end time to get the Topn N reports. The time period for the Topn N reports is usually a week.

items string[]

The items in the query.

limit integer

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

start_time string

The start time to get the Topn N reports. The time period for the Topn N reports is usually a week.

topn_basis string

Possible values: [traffic_volume, transaction_failure, initiation_failure, tcp_flow, udp_flow, audio_traffic_volume, video_traffic_volume, ingress_audio_pkt_loss, egress_audio_pkt_loss, ingress_video_pkt_loss, egress_video_pkt_loss, ingress_audio_jitter, egress_audio_jitter, ingress_video_jitter, egress_video_jitter, ingress_audio_mos, egress_audio_mos]

The basis of the Top N reports.

type string

Possible values: [app, site]

The type of Top N report.

Example (from schema)

{
  "top_n": {
    "end_time": "string",
    "items": [
      "string"
    ],
    "limit": 0,
    "start_time": "string",
    "topn_basis": "traffic_volume",
    "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": "APP_FILTER_NOT_SUPPORTED_FOR_TYPE"
      },
      {
        "code": "SITE_FILTER_NOT_SUPPORTED_FOR_TYPE"
      },
      {
        "code": "FILTER_NOT_SUPPORTED_WITHOUT_SITE"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "PATH_NOT_SUPPORTED_WITH_PATH_TYPE"
      },
      {
        "code": "TOPN_BASIS_NOT_SUPPORTED_WITHOUT_FILTER"
      },
      {
        "code": "INVALID_LIMIT"
      },
      {
        "code": "REQUIRED_PROPERTY"
      },
      {
        "code": "LENGTH_EXCEEDED"
      },
      {
        "code": "PATH_TYPE_LIST_LENGTH_EXCEEDED"
      },
      {
        "code": "INVALID_FILTER"
      },
      {
        "code": "FILTER_NOT_SUPPORTED"
      }
    ]
  }
}

Loading...