Skip to content

analyticsprofile

Configuration for Analytics profile resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName for the analytics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at
(@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow profile" or 'my appflow profile').
Minimum length = 1
Maximum length = 127
collectors<String>Read-writeThe collector can be an IP, an appflow collector name, a service or a vserver. If IP is specified, the transport is considered as logstream and default port of 5557 is taken. If collector name is specified, the collector properties are taken from the configured collector. If service is specified, the configured service is assumed as the collector. If vserver is specified, the services bound to it are considered as collectors and the records are load balanced.
Minimum length = 1
type<String>Read-writeThis option indicates what information needs to be collected and exported.
Possible values = global, webinsight, tcpinsight, securityinsight, videoinsight, hdxinsight, gatewayinsight, httpstream, lsninsight
httpclientsidemeasurements<String>Read-writeOn enabling this option, the Citrix ADC will insert a javascript into the HTTP response to collect the client side page-timings and will send the same to the configured collectors.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httppagetracking<String>Read-writeOn enabling this option, the Citrix ADC will link the embedded objects of a page together.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpurl<String>Read-writeOn enabling this option, the Citrix ADC will log the URL in appflow records.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httphost<String>Read-writeOn enabling this option, the Citrix ADC will log the Host header in appflow records.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpmethod<String>Read-writeOn enabling this option, the Citrix ADC will log the method header in appflow records.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpreferer<String>Read-writeOn enabling this option, the Citrix ADC will log the referer header in appflow records.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpuseragent<String>Read-writeOn enabling this option, the Citrix ADC will log User-Agent header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpcookie<String>Read-writeOn enabling this option, the Citrix ADC will log cookie header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httplocation<String>Read-writeOn enabling this option, the Citrix ADC will log location header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
urlcategory<String>Read-writeOn enabling this option, the Citrix ADC will send the URL category record.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpcontenttype<String>Read-writeOn enabling this option, the Citrix ADC will log content-length header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpauthentication<String>Read-writeOn enabling this option, the Citrix ADC will log Authentication header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpvia<String>Read-writeOn enabling this option, the Citrix ADC will Via header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpxforwardedforheader<String>Read-writeOn enabling this option, the Citrix ADC will log X-Forwarded-For header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpsetcookie<String>Read-writeOn enabling this option, the Citrix ADC will log set-cookie header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpsetcookie2<String>Read-writeOn enabling this option, the Citrix ADC will log set-cookie2 header.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpdomainname<String>Read-writeOn enabling this option, the Citrix ADC will log domain name.
Default value: DISABLED
Possible values = ENABLED, DISABLED
httpurlquery<String>Read-writeOn enabling this option, the Citrix ADC will log URL Query.
Default value: DISABLED
Possible values = ENABLED, DISABLED
tcpburstreporting<String>Read-writeOn enabling this option, the Citrix ADC will log TCP burst parameters.
Default value: ENABLED
Possible values = ENABLED, DISABLED
cqareporting<String>Read-writeOn enabling this option, the Citrix ADC will log TCP CQA parameters.
Default value: DISABLED
Possible values = ENABLED, DISABLED
integratedcache<String>Read-writeOn enabling this option, the Citrix ADC will log the Integrated Caching appflow records.
Default value: DISABLED
Possible values = ENABLED, DISABLED
refcnt<Double>Read-onlyThe number of references to the profile.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| UPDATE| UNSET| DELETE| GET (ALL)| GET| COUNT

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>.

add

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

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"analyticsprofile":{
<b>"name":<String_value>,
</b>"collectors":<String_value>,
<b>"type":<String_value>,
</b>"httpclientsidemeasurements":<String_value>,
"httppagetracking":<String_value>,
"httpurl":<String_value>,
"httphost":<String_value>,
"httpmethod":<String_value>,
"httpreferer":<String_value>,
"httpuseragent":<String_value>,
"httpcookie":<String_value>,
"httplocation":<String_value>,
"urlcategory":<String_value>,
"httpcontenttype":<String_value>,
"httpauthentication":<String_value>,
"httpvia":<String_value>,
"httpxforwardedforheader":<String_value>,
"httpsetcookie":<String_value>,
"httpsetcookie2":<String_value>,
"httpdomainname":<String_value>,
"httpurlquery":<String_value>,
"tcpburstreporting":<String_value>,
"cqareporting":<String_value>,
"integratedcache":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created 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 error

update

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

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"analyticsprofile":{
<b>"name":<String_value>,
</b>"collectors":<String_value>,
"httpclientsidemeasurements":<String_value>,
"httppagetracking":<String_value>,
"httpurl":<String_value>,
"httphost":<String_value>,
"httpmethod":<String_value>,
"httpreferer":<String_value>,
"httpuseragent":<String_value>,
"httpcookie":<String_value>,
"httplocation":<String_value>,
"urlcategory":<String_value>,
"httpcontenttype":<String_value>,
"httpauthentication":<String_value>,
"httpvia":<String_value>,
"httpxforwardedforheader":<String_value>,
"httpsetcookie":<String_value>,
"httpsetcookie2":<String_value>,
"httpdomainname":<String_value>,
"httpurlquery":<String_value>,
"tcpburstreporting":<String_value>,
"cqareporting":<String_value>,
"integratedcache":<String_value>
}}

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 error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"analyticsprofile":{
<b>"name":<String_value>,
</b>"httpclientsidemeasurements":true,
"httppagetracking":true,
"httpurl":true,
"httphost":true,
"httpmethod":true,
"httpreferer":true,
"httpuseragent":true,
"httpcookie":true,
"httplocation":true,
"urlcategory":true,
"httpcontenttype":true,
"httpauthentication":true,
"httpvia":true,
"httpxforwardedforheader":true,
"httpsetcookie":true,
"httpsetcookie2":true,
"httpdomainname":true,
"httpurlquery":true,
"tcpburstreporting":true,
"cqareporting":true,
"integratedcache":true
}}

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 error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile/name_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

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 error

get (all)

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?attrs=property-name1,property-name2

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

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of analyticsprofile resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?pagesize=#no;pageno=#no

Use this query-parameter to get the analyticsprofile resources in chunks.

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:

{ "analyticsprofile": [ {
"name":<String_value>,
"collectors":<String_value>,
"refcnt":<Double_value>,
"type":<String_value>,
"httpclientsidemeasurements":<String_value>,
"httppagetracking":<String_value>,
"httpurl":<String_value>,
"httphost":<String_value>,
"httpmethod":<String_value>,
"httpreferer":<String_value>,
"httpuseragent":<String_value>,
"httpcookie":<String_value>,
"httplocation":<String_value>,
"urlcategory":<String_value>,
"httpcontenttype":<String_value>,
"httpauthentication":<String_value>,
"httpvia":<String_value>,
"httpxforwardedforheader":<String_value>,
"httpsetcookie":<String_value>,
"httpsetcookie2":<String_value>,
"httpdomainname":<String_value>,
"httpurlquery":<String_value>,
"tcpburstreporting":<String_value>,
"cqareporting":<String_value>,
"integratedcache":<String_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile/name_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile/name_value<String>?attrs=property-name1,property-name2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile/name_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

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:

{ "analyticsprofile": [ {
"name":<String_value>,
"collectors":<String_value>,
"refcnt":<Double_value>,
"type":<String_value>,
"httpclientsidemeasurements":<String_value>,
"httppagetracking":<String_value>,
"httpurl":<String_value>,
"httphost":<String_value>,
"httpmethod":<String_value>,
"httpreferer":<String_value>,
"httpuseragent":<String_value>,
"httpcookie":<String_value>,
"httplocation":<String_value>,
"urlcategory":<String_value>,
"httpcontenttype":<String_value>,
"httpauthentication":<String_value>,
"httpvia":<String_value>,
"httpxforwardedforheader":<String_value>,
"httpsetcookie":<String_value>,
"httpsetcookie2":<String_value>,
"httpdomainname":<String_value>,
"httpurlquery":<String_value>,
"tcpburstreporting":<String_value>,
"cqareporting":<String_value>,
"integratedcache":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/analyticsprofile?count=yes

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:

{ "analyticsprofile": [ { "__count": "#no"} ] }