ADC NITRO APIs

videooptimization

Statistics for videooptimization.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
voctpdvideo <Double> Read-only Total number of progressive download HTTP videos
voctpdvideorate <Double> Read-only Rate (/s) counter for voctpdvideo
voctabvideo <Double> Read-only Total number of adaptive bitrate HTTP videos
voctabvideorate <Double> Read-only Rate (/s) counter for voctabvideo
voeabvideo <Double> Read-only Total number of adaptive bitrate HTTPS videos
voeabvideorate <Double> Read-only Rate (/s) counter for voeabvideo
voquicvideo <Double> Read-only Total number of QUIC videos
voquicvideorate <Double> Read-only Rate (/s) counter for voquicvideo
vovideooptother <Double> Read-only Non video traffic
vovideoopherrate <Double> Read-only Rate (/s) counter for vovideooptother
voctabvideoses <Double> Read-only Total number of adaptive bitrate HTTP video sessions
voctabvideosesrate <Double> Read-only Rate (/s) counter for voctabvideoses
voeabvideoses <Double> Read-only Total number of adaptive bitrate HTTPS videos
voeabvideosesrate <Double> Read-only Rate (/s) counter for voeabvideoses
voquicvideoses <Double> Read-only Total number of sessions with QUIC videos
voquicvideosesrate <Double> Read-only Rate (/s) counter for voquicvideoses
voctpdvideobytes <Double> Read-only Total number of bytes for progressive download HTTP videos
voctpdvideobytesrate <Double> Read-only Rate (/s) counter for voctpdvideobytes
voctabvideobytes <Double> Read-only Total number of bytes for adaptive bitrate HTTP videos
voctabvideobytesrate <Double> Read-only Rate (/s) counter for voctabvideobytes
voeabvideobytes <Double> Read-only Total number of bytes for adaptive bitrate HTTPS videos
voeabvideobytesrate <Double> Read-only Rate (/s) counter for voeabvideobytes
voquicvideobytes <Double> Read-only Total number of bytes for QUIC videos
voquicvideobytesrate <Double> Read-only Rate (/s) counter for voquicvideobytes
vovideooptotherbytes <Double> Read-only Total number of bytes for non video traffic
vovideoopherbytesrate <Double> Read-only Rate (/s) counter for vovideooptotherbytes

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/videooptimization Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/videooptimization? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get videooptimization resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/stat/videooptimization? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "videooptimization": [ {
"voquicvideoses":<Double_value>,
"voquicvideobytes":<Double_value>,
"voctabvideobytes":<Double_value>,
"vovideoopherbytesrate":<Double_value>,
"voctpdvideo":<Double_value>,
"voeabvideo":<Double_value>,
"voeabvideobytesrate":<Double_value>,
"voctabvideo":<Double_value>,
"voctpdvideorate":<Double_value>,
"voctabvideosesrate":<Double_value>,
"voquicvideorate":<Double_value>,
"voctpdvideobytesrate":<Double_value>,
"voctabvideobytesrate":<Double_value>,
"vovideooptother":<Double_value>,
"voctpdvideobytes":<Double_value>,
"voctabvideorate":<Double_value>,
"voeabvideosesrate":<Double_value>,
"voctabvideoses":<Double_value>,
"voeabvideoses":<Double_value>,
"voquicvideo":<Double_value>,
"voeabvideorate":<Double_value>,
"voquicvideosesrate":<Double_value>,
"vovideoopherrate":<Double_value>,
"voquicvideobytesrate":<Double_value>,
"vovideooptotherbytes":<Double_value>,
"voeabvideobytes":<Double_value>
}]}

<!--NeedCopy-->
videooptimization