- URL:
- https://<root>/usagereports/<usageReport>/data
- Methods:
GET- 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.
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 data operation retrieves server usage data for the report. This operation aggregates and filters server usage statistics for the entire ArcGIS Server site. The report data is aggregated in a time slice, which is obtained by dividing up the time duration by the default (or specified) aggregation parameter in the report. Each time slice is represented by a timestamp, which represents the ending period of that time slice.
In the JSON response, the queried data is returned for each metric-resource URI combination in a query. In the report-data section, the queried data is represented as an array of numerical values. A response of null indicates that data is not available or requests were not logged for that metric in the corresponding time-slice.
Request parameters
| Parameter | Description |
|---|---|
| The report data can be filtered by the machine where the data is generated. The filter accepts a comma separated list of machine names; Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample GET request for the data operation:
https://organization.example.com/<context>/admin/usagereports/1394810360738/data?filter={"machines":"*"}&f=pjsonJSON Response examples
{
"report": {
"reportname": "Sample World Cities",
"metadata": "This is a random test String that could contain report metadata in any format",
"time-slices": [
1387454987624,
1387469387624,
1387483787624
],
"report-data": [
[
{
"resourceURI": "services/SampleWorldCities.MapServer",
"metric-type": "RequestCount",
"data": [
10,
20,
33
]
},
{
"resourceURI": "services/SampleWorldCities.MapServer",
"metric-type": "RequestsFailed",
"data": [
0,
1,
2
]
},
{
"resourceURI": "services/System",
"metric-type": "RequestCount",
"data": [
100,
200,
300
]
},
{
"resourceURI": "services/System",
"metric-type": "RequestsFailed",
"data": [
11,
22,
33
]
}
],
[
{
"resourceURI": "services/System/CachingTools.GPServer",
"metric-type": "RequestAvgResponseTime",
"data": [
1.1,
1.2,
1.3
]
},
{
"resourceURI": "services/System/CachingTools.GPServer",
"metric-type": "RequestsTimedOut",
"data": [
9,
8,
7
]
}
]
]
}
}