Edit Usage Reports Settings

URL:: https://<root>/usagereports/settings/edit
Methods:: POST
Required Capability:: Access allowed only with the default administrator role
Version Introduced:: 10.3

Description

The edit operation updates the usage report settings. The usage reports settings are applied to the entire site.

Request parameters

Parameter	Description
`enabled`	When usage reports are enabled (`true`), service usage statistics are collected and persisted to a statistics database. When usage reports are disabled (`false`), the statistics are not collected. Values: `true` \| `false`
`samplingInterval`	Defines the duration (in minutes) for which the usage statistics are aggregated or sampled, in-memory, before being written out to the statistics database. Example Use dark colors for code blocksCopy `1 samplingInterval=30`
`maxHistory`	Represents the number of days after which usage statistics are deleted after the statistics database. If the `maxHistory` parameter is set to 0, the statistics are persisted forever. The default value is 0 (forever). Example Use dark colors for code blocksCopy `1 maxHistory=0`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample POST request for the edit operation:

Use dark colors for code blocksCopy
POST /webadaptor/usagereports/settings/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

enabled=true&samplingInterval=30&maxHistory=0&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "settings": {
    "enabled": true,
    "samplingInterval": 30,
    "maxHistory": 0
  }
}

JSON Response example

Use dark colors for code blocksCopy
{
  "status": "success",
  "settings": {
    "enabled": true,
    "samplingInterval": 30,
    "maxHistory": 0,
    "statisticsDir": "\\\\server\\ags\\directories\\arcgissystem"
  }
}