List Exchange Storage History

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_exchange_storage_history

Description

Returns the daily (interval=DAY), weekly (interval=WEEK) or monthly (interval=MONTH) Exchange Store Size information for a device. Only available for devices where the (Windows server only) Exchange Store Size Check is configured.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_exchange_storage_history&required_parameters={parameter-value}

Parameter	Type	Default Value	Description	Allowed Values
deviceid	Integer	0	The device ID must be a valid identifier.
interval	String	DAY	Interval length for data retrieval.	DAY, WEEK, MONTH
since	String	0	Only obtain data since this date/time (inclusive); otherwise, all available data is returned.

Optional parameters

Add optional parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_exchange_storage_history&optional_parameters={parameter-value}

Parameter	Description	Type	Required	Options	Default
describe	Returns a description of the service.	boolean	no	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
deviceid	list_devices_at_client	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_servers&siteid=SITEID
	list_workstations	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_workstations&siteid=SITEID
siteid	list_sites	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_clients

Examples

List Exchange Storage History

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_exchange_storage_history&deviceid=DEVICEID&interval=INTERVAL&since=SINCE

Example response

<?xml version="1.0" ?>
<example>
  <result created="2024-09-26T11:49:41+01:00" host="SERVER" status="OK">
    <store>
      <store_name>an_exchange_store_name</store_name>
      <edb_file>C:\a\path\to\edb\file</edb_file>
      <slv_file>C:\a\path\to\slv\file</slv_file>
      <check_id>17186</check_id> {/* Check responsible for populating this data */}
      <history>
        <data>
          <day>2024-08-05</day> {/* only if interval=DAY. UTC ISO-8601 year month day */}
          <week>2024W31</week> {/* only if interval=WEEK. UTC ISO-8601 year week */}
          <month>2024-08</month> {/* only if interval=MONTH. UTC ISO-8601 year month */}
          <store_size>52672</store_size> {/* megabytes */}
        </data>
        <data>
          <day>2013-08-06</day>
          <store_size>52978</store_size>
        </data>
        <data>
          <day>2013-08-07</day>
          <store_size>54241</store_size>
        </data>
        {<!-- ...more data elements... -->}
      </history>
    </store>
    {<!-- ...more store elements (if applicable)... -->}
  </result>
</example>

Returned fields

Field	Type	Can Be Empty	Description
store_name	string	no	Name of monitored Exchange store
edb_file	string	yes	Name of monitored/measured EDB file
slv_file	string	yes	Name of monitored/measured SLV file
check_id	string	yes	The check which populated this data
history	list (data elements in XML)	yes	Each entry contains:

Notes

Data is available for a maximum of 61 intervals (for each possible interval), if you need data for longer you must store a copy yourself then - for efficiency - provide the since parameter to only request new data