Edit - Usage Reports Settings | ArcGIS REST APIs

URL:: https://<root>/usagereports/settings/edit
Methods:: POST
Version Introduced:: 10.3

Access requirements

Required privileges

The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Default administrator role only

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.

Learn how to generate a token

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 /<context>/usagereports/settings/edit HTTP/1.1
Host: organization.example.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"
  }
}