Get Top N Data (v3.0)

List all the top N data.

application/json

Request Body

Filter for top N

end_time date required
The end time to get the Topn N reports. The time period for the Topn N reports is usually for a week.
filter AppStatsTopNFilter required
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 required
The name of the Top N report. Maz size = 128.
start_time date required
The start time to get the Topn N reports. The time period for the Topn N reports is usually for week.
top_n AppStatsTopNView required
The details of the limit and type of the Top N reports.
limit integer required
The limit of the Top N reports.
type string required
Possible values: [app, site]
The type of Top N reports.
topn_basis string required
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

Successful Operation

application/json

Schema
Example (from schema)

Schema

top_n AppStatsTopNResponseData required
The details of the Top N reports.
end_time string required
The end time to get the Topn N reports. The time period for the Topn N reports is usually a week.
items string[] required
The items in the query.
limit integer required
The details of the limit and type of the Top N reports.
start_time string required
The start time to get the Topn N reports. The time period for the Topn N reports is usually a week.
topn_basis string required
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 required
Possible values: [app, site]
The type of Top N report.

{
  "top_n": {
    "end_time": "string",
    "items": [
      "string"
    ],
    "limit": 0,
    "start_time": "string",
    "topn_basis": "traffic_volume",
    "type": "app"
  }
}

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": "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"
      }
    ]
  }
}

Get Top N Data (v3.0)​

Get Top N Data (v3.0)