Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Requesting NTA Top Application Statistics

 

Use the Cloud Analytics Engine DLE API as follows to retrieve Network Traffic Analysis (NTA) top-performing application statistics from network devices known to DLE.

GET /api/v1/nta/top-applications

Use this DLE API request to get NTA top application flow statistics collected by DLE. Response data is in JSON format.

Request Format:

  • GET method

Request Parameters:

  • Table 1 describes the request parameters.

    Table 1: NTA Top Applications Request Parameters

    Request Parameter

    Description

    device

    (String) Device IP address.

    if-index

    (String) Interface SNMP index.

    start

    (Numeric) Start time in ms (epoch time). Query DLE for data starting at this timestamp.

    end

    (Numeric) Optional end time in ms (epoch time). Query DLE for data up until this timestamp.

    count

    (Numeric) Requested limit on number of top application statistics results returned (out of total available).

Response Data:

  • Table 2 describes the response data.

    Table 2: NTA Top Applications Response Data Object

    Element Name

    Description

    total-applications

    (Numeric) Total number of applications for which statistics were collected.

    avg-byte-count

    (Numeric) Average byte count for all applications for which statistics were collected.

    limit

    (Numeric) Number of applications for which statistics results are provided in the response. This might be limited based on the requested application count compared to total-applications.

    top-applications

    List of top application statistics data objects (see NTA Top Stats Response Transfer Object) by application identifier pair (port, protocol), based on the request parameters and total applications for which statistics were collected.

See NTA Top Applications Data Learning Engine API Example for a sample request and response.

NTA Top Stats Response Transfer Object

The DLE API returns the NTA top statistics transfer object in response to a request for NTA top application or conversation statistics. (See GET /api/v1/nta/top-applications and GET /api/v1/nta/top-conversations.) The response data is a list of top statistics results, in JSON format, with each result identified by the following elements:

  • For top applications statistics, an application identifier element pair:

    • port: (Numeric) Application port number.

    • protocol: (String) Application transport protocol - “TCP” | “UDP”.

  • Or for top conversation statistics, a conversation identifier element pair:

    • src-ip: (String) Conversation source IP address.

    • dst-ip: (String) Conversation destination IP address.

  • And the remaining elements in Table 3.

    Table 3: NTA Top Stats Response Object Common Elements

    Element Name

    Description

    ingress-bytes

    (Numeric) Total number of ingress bytes generated by the application or on the conversation on the specified interface.

    egress-bytes

    (Numeric) Total number of egress bytes generated by the application or conversation on the specified interface.

    total-bytes

    (Numeric) Total number of bytes (ingress + egress) generated by the application or conversation on the specified interface.

    bytes-percent

    (Numeric, Decimal) Percent of bytes transferred by the specified application or on the specified conversation out of all traffic flow on the specified interface.

    rank

    (Numeric) Rank of this top application or conversation results among all the top applications or conversations in this response.

NTA Top Applications Data Learning Engine API Example

The following is a DLE API example for retrieving NTA top applications statistics from DLE. See GET /api/v1/nta/top-applications and NTA Top Stats Response Transfer Object. This example requests 5 top applications flow statistics results, and the DLE response includes the top 5 applications out of a total of 20 that were collected in the requested time period. If statistics from fewer than 5 applications had been collected, the response would return results for as many applications as were available up to the requested count.

Request:

http://192.168.55.122:8282/api/v1/nta/top-applications?

device=192.168.55.93&if-index=521&start=1441057546726&count=5

Response: