| getanalyticsprofileResult Structure Definition |
The getanalyticsprofileResult structure defines the return type for getanalyticsprofile API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
analyticsprofileList |
List of analyticsprofiles |
| analyticsprofile Structure Definition |
The analyticsprofile structure defines the actual return type values for getanalyticsprofile API. |
Syntax |
Members |
name |
Name of the profile about which to display information. |
collectors |
The 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. |
refcnt |
The number of references to the profile. |
type |
This option indicates what information needs to be collected and exported. |
httpclientsidemeasurements |
On 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. |
httppagetracking |
On enabling this option, the Citrix ADC will link the embedded objects of a page together. |
httpurl |
On enabling this option, the Citrix ADC will log the URL in appflow records |
httphost |
On enabling this option, the Citrix ADC will log the Host header in appflow records |
httpmethod |
On enabling this option, the Citrix ADC will log the method header in appflow records |
httpreferer |
On enabling this option, the Citrix ADC will log the referer header in appflow records |
httpuseragent |
On enabling this option, the Citrix ADC will log User-Agent header. |
httpcookie |
On enabling this option, the Citrix ADC will log cookie header. |
httplocation |
On enabling this option, the Citrix ADC will log location header. |
urlcategory |
On enabling this option, the Citrix ADC will send the URL category record. |
allhttpheaders |
On enabling this option, the Citrix ADC will log all the request and response headers. |
httpcontenttype |
On enabling this option, the Citrix ADC will log content-length header. |
httpauthentication |
On enabling this option, the Citrix ADC will log Authentication header. |
httpvia |
On enabling this option, the Citrix ADC will Via header. |
httpxforwardedforheader |
On enabling this option, the Citrix ADC will log X-Forwarded-For header. |
httpsetcookie |
On enabling this option, the Citrix ADC will log set-cookie header. |
httpsetcookie2 |
On enabling this option, the Citrix ADC will log set-cookie2 header. |
httpdomainname |
On enabling this option, the Citrix ADC will log domain name. |
httpurlquery |
On enabling this option, the Citrix ADC will log URL Query. |
tcpburstreporting |
On enabling this option, the Citrix ADC will log TCP burst parameters. |
cqareporting |
On enabling this option, the Citrix ADC will log TCP CQA parameters. |
integratedcache |
On enabling this option, the Citrix ADC will log the Integrated Caching appflow records |
grpcstatus |
On enabling this option, the Citrix ADC will log the gRPC status headers |
outputmode |
This option indicates the format of REST API POST body. It depends on the consumer of the analytics data. |
metrics |
This option indicates the whether metrics should be sent to the REST collector. |
events |
This option indicates the whether events should be sent to the REST collector. |
auditlogs |
This option indicates the whether auditlog should be sent to the REST collector. |
managementlog |
This option indicates the whether managementlog should be sent to the REST collector. |
servemode |
This option is for setting the mode of how data is provided |
schemafile |
This option is for configuring json schema file containing a list of counters to be exported by metricscollector |
metricsexportfrequency |
This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range |
analyticsauthtoken |
Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk |
analyticsendpointurl |
The URL at which to upload the analytics data on the endpoint |
analyticsendpointcontenttype |
By default, application/json content-type is used. If this needs to be overridden, specify the value. |
analyticsendpointmetadata |
If the endpoint requires some metadata to be present before the actual json data, specify the same. |
dataformatfile |
This option is for configuring the file containing the data format and metadata required by the analytics endpoint. |
topn |
On enabling this topn support, the topn information of the stream identifier this profile is bound to will be exported to the analytics endpoint. |
httpcustomheaders |
Specify the list of custom headers to be exported in web transaction records. |
_nextgenapiresource |
See Also |