Pingdom API / function Report_getDowntimes

Description

Returns downtime summary for current user.

Arguments

stringAPIKey (Required)

API key. You will find your API key in the 'Pingdom API' section of Pingdom Panel.

stringsessionId (Required)

Session ID obtained by calling Auth_login function.

Report_GetDowntimesRequestgetDowntimesRequest (Required)

Object that gives info about time period, resolution and check name.

Return value

Report_GetDowntimesResponsegetDowntimesResponse

Response object of Report_getDowntimes function. It contains field for status of the performed operation, and field for list of downtime objects for current user.

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Report_getDowntimes xmlns:q1="urn:methods">
		<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
		<sessionId xsi:type="xsd:string">77aecec10b00cb286f73c09f7c845483</sessionId>
		<getDowntimesRequest href="#id1" />
	</q1:Report_getDowntimes>
	<q2:Report_GetDowntimesRequest id="id1" xsi:type="q2:Report_GetDowntimesRequest" xmlns:q2="urn:PingdomAPI">
		<from xsi:type="xsd:dateTime">2006-10-01T00:00:00+02:00</from>
		<to xsi:type="xsd:dateTime">2006-11-01T00:00:00+01:00</to>
		<resolution xsi:type="q2:Report_ResolutionEnum">DAILY</resolution>
		<checkName xsi:type="xsd:string">Test check</checkName>
	</q2:Report_GetDowntimesRequest>
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:getDowntimesResponse>
		<return xsi:type="ns2:Report_GetDowntimesResponse">
			<status xsi:type="xsd:int">0</status>
			<downtimesArray SOAP-ENC:arrayType="ns2:Report_DowntimeEntry[32]" xsi:type="ns2:DowntimesArray">
				<item xsi:type="ns2:Report_DowntimeEntry">
					<from xsi:type="xsd:dateTime">2006-09-30T17:00:00-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-01T17:00:00-05:00</to>
					<duration xsi:nil="true"/>
				</item>
				<item xsi:type="ns2:Report_DowntimeEntry">
					<from xsi:type="xsd:dateTime">2006-10-01T17:00:00-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-02T17:00:00-05:00</to>
					<duration xsi:nil="true"/>
				</item>
				<item xsi:type="ns2:Report_DowntimeEntry">
					<from xsi:type="xsd:dateTime">2006-10-02T17:00:00-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-03T17:00:00-05:00</to>
					<duration xsi:nil="true"/>
				</item>


				<!-- Part of XML response is omitted here -->


				<item xsi:type="ns2:Report_DowntimeEntry">
					<from xsi:type="xsd:dateTime">2006-10-31T16:00:00-06:00</from>
					<to xsi:type="xsd:dateTime">2006-11-01T16:00:00-06:00</to>
					<duration xsi:nil="true"/>
				</item>
			</downtimesArray>
		</return>
	</ns1:getDowntimesResponse>
</SOAP-ENV:Body>