- URL:
- https://<root>/usagestatistics
- Methods:
GET- Operations:
- Update Credentials
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise 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.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The usagestatistics resource provides access to the metrics viewer and metrics API tools. As an administrator, you can use these tools to monitor GIS service usage in your organization for feature services, map services, tiled map services, geocode services, and geometry services. Information that can be gathered from service usage statistics includes the following:
- Historical service usage data
- Peak and off-peak periods of service usage
- Slowdown in response times or throughput
Metrics viewer
This resource is only available to deployments using ArcGIS Enterprise 11.1 on Kubernetes or earlier versions. Service usage statistics are collected using a metrics API pod running in your cluster. These metrics are persisted by a metrics API and are exposed through a service metrics viewer pod that queries the metrics API.
The metrics viewer app uses Prometheus and Grafana components to create and view custom dashboards consisting of graph panels for various metrics. You can use PromQL queries on the metrics API to generate graphs for metrics across different periods of time. To learn more about how to view statistics dashboards, and which dashboards are included with your deployment, see View statistics in the ArcGIS Enterprise on Kubernetes help.
Metrics API
As an administrator, you can use the metrics API with PromQL queries to directly query and obtain raw metrics that can be used by third-party viewers or graphical applications that may be running inside or outside of your cluster. The Prometheus monitoring system is used by the metrics API to collect these metrics from each GIS service pod and persist the information into a time-series database. For information on the types of raw metrics collected by the metrics API, see Access the metrics API in the ArcGIS Enterprise on Kubernetes help.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The only supported format is |
Example usage
The following is a sample request URL used to access the usagestatistics resource:
https://organization.example.com/<context>/admin/usagestatistics?f=html