Usage Report

URL:
https://<root>/usagereports/<usageReport>
Methods:
GET
Operations:
Edit, Data, Delete
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.3

Description

The resource for an individual usage report returns the parameters of the report.

A usage report is used to obtain ArcGIS Server usage data for specified resources during a given time period. It specifies the parameters for obtaining server usage data, time range (since from and to parameters), aggregation interval, and queries (which specify the metrics to be gathered for a collection of server resources, such as folders and services).

Request parameters

ParameterDescription

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access an individual usage report resource:

1
https://machine.domain.com/webadaptor/admin/usagereports/1394219221008?f=pjson

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "reportname": [unique name or id of the report],
  "since": [" LAST_DAY | LAST_WEEK | LAST_MONTH | LAST_YEAR | CUSTOM"],
  "from" : [timestamp],  //Optional, specified when "since" is CUSTOM
  "to": [timestamp],  //Optional, specified when “since” is CUSTOM
  "aggregationInterval": [minutes],  //Optional, aggregation interval in minutes
  "queries": [
    {
      "resourceURIs": ["services/Map_bv_999.MapServer"], //Comma separated list of services and/or folders
      "metrics": ["RequestCount"] // Comma separated list of metrics
    }
  ],
  "metadata": "This could be any String or JSON Object."
}

JSON Response example

A usage report is represented in JSON format below.

1
2
3
4
5
6
7
8
9
10
11
{
  "reportname": 1394219221008,
  "since": "LAST_MONTH",
  "queries": [
    {
      "resourceURIs": ["services/Map_bv_999.MapServer"],
      "metrics": ["RequestCount"]
    }
  ],
  "metadata": "This could be any String or JSON Object. The next usage report below shows how this parameter is used be ArcGIS manager for storing report metadata."
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close