Skip To Content
ArcGIS Developers
Dashboard

Edit Usage Reports Settings

Description

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

Request parameters

ParameterDescription
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

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

maxHistory=0
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for edit:

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=json

JSON Response syntax

{
  "settings": {
    "enabled": true,
    "samplingInterval": 30,
    "maxHistory": 0
  }
}

JSON Response example

{
  "status": "success",
  "settings": {
    "enabled": true,
    "samplingInterval": 30,
    "maxHistory": 0,
    "statisticsDir": "\\\\server\\ags\\directories\\arcgissystem"
  }
}