Usage Reports

URL:: https://<root>/usagereports
Methods:: GET
Required Capability:: Access allowed with any authorized privilege
Version Introduced:: 10.3

Description

The usagereports resource is a collection of all the usage reports created within your site. The Create Usage Report operation lets you define a new usage report.

Request parameters

Parameter	Description
`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 the usagereports resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/usagereports?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
   "metrics": [<usage-report1>, < usage-report2>]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "metrics": [
    {
      "reportname": 1394219221008,
      "since": "LAST_MONTH",
      "queries": [
        {
          "resourceURIs": ["services/Map_bv_999.MapServer"],
          "metrics": ["RequestCount"]
        }
      ],
      "metadata": "This could be any String or JSON Object. The usage report below shows how this parameter is used for storing report metadata."
    }
  ],
  {
    "reportname": 1394223588659,
    "since": "LAST_MONTH",
    "queries": [
      {
        "resourceURIs": [
          "services/Map_bv_999.MapServer",
          "services/",
          "services/Map_bv_901.MapServer"
        ],
      "metrics": ["RequestCount"]
      }
    ],
    "metadata": {
      "temp": false,
      "title": "Request Count Report",
      "styles": {
        "services/Map_bv_901.MapServer": {
          "color": "#B82500",
          "marker": "m-3-3l 0 6 6 0 0-6z"
        },
        "services/": {"marker": "m 0-3l 3 3-3 3-3-3z"},
        "services/Map_bv_999.MapServer": {
          "color": "#E97000",
          "marker": "m-3 3l 3-6 3 6z"
        }
      }
    }
  }
}