- URL: https://<usageReport-url>/data
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.3
Description
This 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) aggregationInterval 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 |
|---|---|
| filter | The report data can be filtered by the machine where the data is generated. The filter accepts a comma separated list of machine names; * represents all machines. Example |
| f | The response format. The default response format is html. Values: html | json | csv | pjson |
Example usage
Below is a sample request URL for data:
https://machine.domain.com/webadaptor/admin/usagereports/1394810360738/data?filter={"machines":"*"}&f=pjsonJSON Response example
Note:
A response of null indicates that data is not available or requests were not logged for that metric in the corresponding time-slice.
{
"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
]
}
]
]
}JSON response example for a report with two queries
Note:
A response of null indicates that data is not available or requests were not logged for that metric in the corresponding time-slice.
{
"reportname": "Sample Report",
"since": "LAST_WEEK",
"queries": [
{
"resourceURIs": [
"services/SampleWorldCities.MapServer",
"services/System"
],
"metrics": [
"RequestCount",
"RequestsFailed"
]
},
{
"resourceURIs": ["services/System/CachingTools.GPServer"],
"metrics": [
"RequestAvgResponseTime",
"RequestsTimedOut"
]
}
],
"metadata": "This is a random test String that could contain report metadata in any format"
}