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.
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 generate 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.
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://organization.example.com/<context>/admin/usagereports/settings?f=pjsonJSON Response example
{
"enabled": true,
"samplingInterval": 30,
"maxHistory": 0,
"statisticsDir": "\\\\agsserver\\ags\\directories\\arcgissystem"
}