APIRef_tm_analytics_report¶
mgmt/tm/analytics/report
Analytic report generation
REST Endpoints
- Collection URI
/mgmt/tm/analytics/report- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/analytics/report/~resource id- Resource Methods
OPTIONS, GET, POST
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
device |
string | optional | read/write | Specifies a BIG-IP device to generate a report on. | |
deviceGroup |
string | optional | read/write | ||
deviceList |
string | optional | read/write | Specifies a custom list of BIG-IP devices to generate a report on. | |
displayedMeasure |
string | optional | read/write | When more than one measure is selected, this field specifies the measure that is shown in the timeseries chart and the bar/pie chart. | |
drilldown |
string | optional | read/write | Specifies specific entities that will be used as a filter. | |
emailAddresses |
string | optional | read/write | Specifies a list of email addresses which the report file is sent to. | |
file |
string | optional | read/write | Specifies the exported file path to be saved. The specified file name should be simple (not a full path). | |
format |
string | csv-aggregated | optional | read/write | Specifies the exported file format to be saved or sent. |
limit |
integer | optional | read/write | Specifies the (maximum) number of rows in the output result set. The default limit is 10 rows, not including the “Total” row. The maximum limit is 1000 rows. | |
measures |
string | optional | read/write | Specifies a list of measures that can be specified for the chosen entity type. Default setting is dependant on the selected “view-by” entity. | |
orderBy |
string | optional | read/write | Specifies the measures and sort type (ascending or descending) that will be used to sort the final report. Default setting for measures : previously chosen measures. Default setting for sort type: descending. | |
range |
string | optional | read/write | Specifies the time/date range of the analytics information that you want to display. The given results will reflect the time range chosen here. Default setting : last hour ( now–now-1h ) | |
smtpConfigOverride |
string | optional | read/write | Specifies the SMTP configuration to use when sending reports by email. This overrides the default SMTP settings. | |
viewBy |
string | optional | read/write | The main entity by which the report will be viewed |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.