APIRef_tm_analytics_pool-traffic_scheduled-reportΒΆ

mgmt/tm/analytics/pool-traffic/scheduled-report

/tm/analytics/pool-traffic

Scheduled analytics report

REST Endpoints

Collection URI
/mgmt/tm/analytics/pool-traffic/scheduled-report
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/analytics/pool-traffic/scheduled-report/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write  
emailAddresses string   required read/write A list of the email addresses of the recipients that receive the scheduled report.
firstTime string   required read/write Defines which predefined report (AKA predefined filter) will be used to generate the report.
frequency string   required read/write The scheduled report frequency.
includeTotal string disabled optional read/write Enables or disables including a summary (Overall result) entity in results.
lastFailureTime string 0 optional read/write  
lastRunErrorMessage string   optional read/write The last error message of the scheduled report in case of failure.
lastRunStatus string none optional read/write The last run status of the scheduled report.
lastSentTime string 0 optional read/write  
moduleName string   optional read/write  
nextTime string   optional read/write  
tmPartition string Common optional read/write  
predefinedReportName string   optional read/write Defines which predefined report (AKA predefined filter) will be used to generate the report.
smtpConfig string   optional read/write Defines which SMTP configuration will be used to send the scheduled report. If set to none, the scheduled report will be disabled.

Structures

Name Type Default Value Required Access Description
/multi-leveled-report array_structure   optional read/write  
/multi-leveled-report/chart-path string   optional read/write A list of entities that define the scope in which the report will be displayed.
/multi-leveled-report/limit integer 10 optional read/write The number of view-by entities displayed in the scheduled report.
/multi-leveled-report/measures string   optional read/write  
/multi-leveled-report/time-diff string 0 optional read/write The time range for the report.
/multi-leveled-report/view-by string   optional read/write The main entity that the report is viewed by.
/multi-leveled-report/chart-path string   optional read/write A list of entities that define the scope in which the report will be displayed.
/multi-leveled-report/limit integer 10 optional read/write The number of view-by entities displayed in the scheduled report.
/multi-leveled-report/measures string   optional read/write  
/multi-leveled-report/time-diff string 0 optional read/write The time range for the report.
/multi-leveled-report/view-by string   optional read/write The main entity that the report is viewed by.
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.