The Get Usage Report operation returns a usage report for one, several or all monitors.
Syntax
Request URL
GET https://www.alertsite.com/report-api/usage/{customer-id}?[report_parameters]
Parameters
This endpoint is valid for Version 2 only.
devices
The monitor’s identifier. If omitted, all applicable monitors or a comma-separated list of monitor IDs.
dimensions
A dimensional filter for results, aggregated by the requested content. See below for more information.
dow
Numeric values for days of the week. Can be a comma-separated list. Specify 0 for Sunday, 1 for Monday, and so on.
format
The output format.
Possible values: XML (default), JSON.
hours
Numeric values for hours of the day. Can be a comma-separated list. Specify 0 for midnight.
locations
The location ID. If omitted, all locations or a comma-separated list of location IDs.
rdate | start_date+end_date
A relative date or date range. See below.
Available Relative Date Ranges
| Value | Description |
|---|---|
LastOneHour |
Last 1 hour. |
LastTwoHours |
Last 2 hours. |
LastFourHours |
Last 4 hours. |
LastEightHours |
Last 8 hours. |
LastTwelveHours |
Last 12 hours. |
LastTwentyFourHours |
Last 24 hours. |
LastFortyEightHours |
Last 48 hours. |
Today |
Today. |
Yesterday |
Yesterday. |
LastTwoDays |
Last 2 days. |
LastThreeDays |
Last 3 days. |
LastSevenDays |
Last 7 days. |
LastEightDays |
Last 8 days. |
ThisWeek |
This week (beginning Sunday). |
ThisMonth |
This month. |
LastMonth |
Last month. |
LastWeek |
Last week (beginning Sunday). |
LastBizWeek |
Last business week. |
Dimensions
Valid dimensions for the Usage report, which can be a comma-separated list.
| Note: | The default value is device if no dimensions are specified. |
| Value | Description |
|---|---|
device |
By monitor. |
location |
By monitor location. |
month |
By month. |
week |
By week (starts on Sunday). |
bizweek |
By week (starts on Monday). |
dayofweek |
By day of the week. |
day |
By date. |
year |
By year. |
Example
-
This URL returns the Usage data for the customer ID C99999 for all monitors from all locations for This Quarter:
https://www.alertsite.com/report-api/usage/C99999?&rdate=ThisQuarter&api_version=2
See Also
Get Detail Report
Get Page Objects Report
Get Site Status Report
Get SLA Detail Report
Get Transaction Detail Report
Get Outage Report
AlertSite Report API