Skip to content
Was this article helpful?

web_summary

Configuration for AF WEB Summary Report table resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ssl_error_type <Integer> Read-write SSL Error Type. frontend=1, backend=2..
__count <Double> Read-write count..
sslVersion_frontend <Integer> Read-write SSL Error Type. frontend=1, backend=2..
network_latency_client_side <Double> Read-write Network latency client side..
render_time <Double> Read-write Render time..
ip_address <String> Read-write Source IP Address.

Minimum length = 1

Maximum length = 64
id <String> Read-write Id is HTTP Req URL..

Maximum length = 2000
cipherstrength_frontend <Integer> Read-write SSL Error Type. frontend=1, backend=2..
total_bytes <Double> Read-write Total bytes accounted by this URL in sampled timeframe..
rpt_sample_time <Double> Read-write Report Sample time..
srvr_cert_hash_frontend <Integer> Read-write SSL Error Type. frontend=1, backend=2..
server_response_time <Double> Read-write Server response time..
load_time <Double> Read-write URI Load time..
network_latency_server_side <Double> Read-write Network latency server side..
servercertsize_frontend <Integer> Read-write SSL Error Type. frontend=1, backend=2..
application_response_time <Double> Read-write Application response time..
total_dist_count <Double> Read-write Total Distinct entity count.
total_requests <Double> Read-write Count of this URL in given sampled timeframe..

Operations

(click to see Properties )

  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note: Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/web_summary Query-parameters:

cr_enabled Use this query-parameter to indicate cr is enabled or not.

Possible Values: 0, 1 report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds asc Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values: yes, no order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: total_requests, load_time, render_time type Use this query-parameter to specify the type.

Possible Values: total_requests, load_time, render_time HTTPS Method: GET

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "web_summary":[{
"ssl_error_type":<Integer_value>,
"__count":<Double_value>,
"sslVersion_frontend":<Integer_value>,
"network_latency_client_side":<Double_value>,
"app_unit_name":<String_value>,
"render_time":<Double_value>,
"ip_address":<String_value>,
"id":<String_value>,
"cipherstrength_frontend":<Integer_value>,
"total_bytes":<Double_value>,
"rpt_sample_time":<Double_value>,
"device_ip_address":<String_value>,
"ctnsappname_b":<String_value>,
"srvr_cert_hash_frontend":<Integer_value>,
"server_response_time":<Double_value>,
"load_time":<Double_value>,
"network_latency_server_side":<Double_value>,
"servercertsize_frontend":<Integer_value>,
"application_response_time":<Double_value>,
"total_dist_count":<Double_value>,
"total_requests":<Double_value>,
"app_unit_ip_address":<String_value>}]}
Was this article helpful?