- URL:
- https://<root>/usagereports/settings
- Methods:
GET- Required Capability:
- Access allowed with either the "Update", "Delete", "Security and Infrastructure", or "Servers" privileges
- Version Introduced:
- 10.3
Description
The settings resource returns the current usage reports settings. The usage reports settings are applied to the entire site. When usage reports are enabled, service usage statistics are collected and persisted to a statistics database. When usage reports are disabled, the statistics are not collected. The sampling parameter defines the duration (in minutes) during which the usage statistics are sampled and collected (in-memory) before being written out to the statistics database. Database entries are deleted after the interval specified in the max parameter (in days), unless the max parameter is 0, for which the statistics are persisted forever.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the settings resource:
https://machine.domain.com/webadaptor/admin/usagereports/settings?f=pjsonJSON Response example
{
"enabled": true,
"samplingInterval": 30,
"maxHistory": 0,
"statisticsDir": "\\\\agsserver\\ags\\directories\\arcgissystem"
}