Citrix ADC 12.1 NITRO API Reference

feo

August 17, 2023

Contributed by:

Statistics for feo.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
optcacheobjects	Read-only	Total number of optimized cache objects ready to be served.
optcacheobjectsrate	Read-only	Rate (/s) counter for optcacheobjects
origcacheobjects	Read-only	Total number of original cache objects ready to be served.
origcacheobjectsrate	Read-only	Rate (/s) counter for origcacheobjects
totalimgsdomainsharded	Read-only	Total no of images whose domain has been set from shards.
imgsdomainshardedrate	Read-only	Rate (/s) counter for totalimgsdomainsharded
totalimgslazyloaded	Read-only	Total number of images modified for lazy loading.
imgslazyloadedrate	Read-only	Rate (/s) counter for totalimgslazyloaded
toturireplaced	Read-only	Total number of URI replaced.
urireplacedrate	Read-only	Rate (/s) counter for toturireplaced
totalimgsinlinedincss	Read-only	Total number of images inlined in CSS.
imgsinlinedincssrate	Read-only	Rate (/s) counter for totalimgsinlinedincss
totalinlinedjs	Read-only	Total number of inlined JS files.
inlinedjsrate	Read-only	Rate (/s) counter for totalinlinedjs
totalinlinedcss	Read-only	Total number of inlined CSS files.
inlinedcssrate	Read-only	Rate (/s) counter for totalinlinedcss
totalinlinedimgs	Read-only	Total number of inlined images in HTML.
inlinedimgsrate	Read-only	Rate (/s) counter for totalinlinedimgs
totaldatasavings	Read-only	Total data savings in bytes.
datasavingsrate	Read-only	Rate (/s) counter for totaldatasavings
htmlcommentsremoved	Read-only	The total number of HTML comments removed.
htmlcommentsremovedrate	Read-only	Rate (/s) counter for htmlcommentsremoved
totalcacheextended	Read-only	The total number of objects cache extended.
cacheextendedrate	Read-only	Rate (/s) counter for totalcacheextended
totalcsscombined	Read-only	The total number of CSS combined.
csscombinedrate	Read-only	Rate (/s) counter for totalcsscombined
totalimporttolink	Read-only	The total number of CSS imports converted to links
importtolinkrate	Read-only	Rate (/s) counter for totalimporttolink
totaljsmoved	Read-only	The total number of JS moved to end.
jsmovedrate	Read-only	Rate (/s) counter for totaljsmoved
totalcssmoved	Read-only	The total number of CSS moved to head.
cssmovedrate	Read-only	Rate (/s) counter for totalcssmoved
totaljsmin	Read-only	The total number of JS files minified.
jsminrate	Read-only	Rate (/s) counter for totaljsmin
totalcssmin	Read-only	The total number of CSS files minified.
cssminrate	Read-only	Rate (/s) counter for totalcssmin
totalimgstojxr	Read-only	The total number of images converted to JPEGXR format.
imgstojxrrate	Read-only	Rate (/s) counter for totalimgstojxr
totalimgstowebp	Read-only	The total number of images converted to WEBP format.
imgstowebprate	Read-only	Rate (/s) counter for totalimgstowebp
totaljpegsoptimized	Read-only	The total number of JPEG format images optimized.
jpegsoptimizedrate	Read-only	Rate (/s) counter for totaljpegsoptimized
totalgifstopng	Read-only	The total number of images converted from GIF to PNG format.
gifstopngrate	Read-only	Rate (/s) counter for totalgifstopng
totalimgsresized	Read-only	The total number of images resized to dimensions in the tag.
imgsresizedrate	Read-only	Rate (/s) counter for totalimgsresized

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/feo

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/feo?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "feo": [ {
"totaljsmoved":<Double_value>,
"totalimgslazyloaded":<Double_value>,
"htmlcommentsremovedrate":<Double_value>,
"urireplacedrate":<Double_value>,
"cssmovedrate":<Double_value>,
"htmlcommentsremoved":<Double_value>,
"jsmovedrate":<Double_value>,
"totalimgsinlinedincss":<Double_value>,
"totalinlinedcss":<Double_value>,
"inlinedimgsrate":<Double_value>,
"toturireplaced":<Double_value>,
"imgstowebprate":<Double_value>,
"totalinlinedjs":<Double_value>,
"totalcssmoved":<Double_value>,
"csscombinedrate":<Double_value>,
"imgslazyloadedrate":<Double_value>,
"totaljsmin":<Double_value>,
"optcacheobjects":<Double_value>,
"totalgifstopng":<Double_value>,
"totalimgsresized":<Double_value>,
"imgsinlinedincssrate":<Double_value>,
"inlinedcssrate":<Double_value>,
"totalimgstowebp":<Double_value>,
"inlinedjsrate":<Double_value>,
"origcacheobjectsrate":<Double_value>,
"cssminrate":<Double_value>,
"totalimgsdomainsharded":<Double_value>,
"imgsdomainshardedrate":<Double_value>,
"gifstopngrate":<Double_value>,
"importtolinkrate":<Double_value>,
"totalcsscombined":<Double_value>,
"totalimgstojxr":<Double_value>,
"imgsresizedrate":<Double_value>,
"optcacheobjectsrate":<Double_value>,
"totaljpegsoptimized":<Double_value>,
"totalcacheextended":<Double_value>,
"origcacheobjects":<Double_value>,
"jsminrate":<Double_value>,
"jpegsoptimizedrate":<Double_value>,
"totaldatasavings":<Double_value>,
"imgstojxrrate":<Double_value>,
"datasavingsrate":<Double_value>,
"cacheextendedrate":<Double_value>,
"totalcssmin":<Double_value>,
"totalinlinedimgs":<Double_value>,
"totalimporttolink":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

feo

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

feo

Properties

Operations

get (all)

In this article