RM Peak Report
This report describes the peak usage of a Resource Manager within a period of time, as a sequence of peaks within some fixed duration (known as "granularity") between a start and end time. Each report contains a manifest section.
Web Service Endpoint
This report is available at the web service endpoint /ems-rs/operations/peaks/RM.
Input Parameters
This report accepts the following Request URI parameters:
| Parameter | Description |
|---|---|
| granularity | This describes the unit of time for this report. It can take one of the following value:
Each bin of the report will represent the number of calls arrived within that period of time. This parameter is required. |
| from | This describes the start of the period the report would be for. If the "from" does not align with the granularity, the report will normalize the "from" time to the granularity boundary mark before the specified value. This parameter is required. |
| to | This describes the end of the period the report would be for. If the "to" does not align with the granularity, the report will normalize the "to" time to the granularity boundary mark after the specified value. This parameter is optional. |
| app-id | This describes the target IVR Profile Config Server DBID. This may be specified zero or more times. If specified, the report will contain peak data only for the specified app-id.
This cannot be specified with either the tenant-id or the dn parameter. |
| tenant-id | This describes the target Tenant Config Server DBID. This may be specified zero or more times. If specified, the report will contain arrival data only for the specified tenant-id.
This cannot be specified with either the app-id or the dn parameter. |
| dn | This describes the target DN. This may be specified zero or more times. If specified, the report will contain arrival data only for the specified dn.
The format of the dn parameter may be one of the following:
Note: if none of app-id, tenant-id, and dn are specified, the report will contain the information across all the applications. |
| comp-id | This describes the target components. This may be specified zero or more times. If specified, the report will contain arrival data only for the specified set of comp-id’s. If no comp-id is specified, the report will contain arrival data for all the Resource Manager components in the system. |
| sma-period | This takes a value of a positive integer. It can be specified only if the granularity parameter equals DAY. When this parameter is specified, the generated report would contain data for simple moving average of daily data for the past x days, where x is the value of the ‘sma-period’ parameter. That is, the value for some Date in the report is the average value of the x days on and before Date for the data type requested. If no value is specified for the sma-period parameter, a default value of 42 is used. |
Output Format
The output for this report consists of a list of <call-peaks> XML elements. Each <call-peaks> element contains a sequence of arrival data in the requested time range, for the specified Application/Tenant/DN. Each <bin> in the sequence represents the peak within a unit of time specified by granularity, and it is further broken down into call type. It conforms to the RelaxNG schema CallPeakReport.rng. Download the GVP RNG Schemas An example report body for this report is as follows:
<call-peaks comp-type="RM" start="2010-02-03T08:00:00Z" end="2010-02-03T10:00:00Z" granularity="HOUR">
<applications>
<application href="/applications/137" />
</applications>
<bins count="2">
<bin index="0">
<calls type="INBOUND" count="1" />
</bin>
<bin index="1" />
</bins>
</call-peaks>
<call-peaks comp-type="RM" start="2010-02-03T08:00:00Z" end="2010-02-03T10:00:00Z" granularity="HOUR">
<applications>
<application href="/applications/321" />
</applications>
<bins count="2">
<bin index="0">
<calls type="INBOUND" count="1" />
<calls type="OUTBOUND" count="1" />
</bin>
<bin index="1" />
</bins>
</call-peaks>