Pingdom API / function Report_getResponseTimes

Description

Returns response times 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_GetResponseTimesRequestgetResponseTimesRequest (Required)

Object that gives info about time period, resolution, check name and locations for response times analysis.

Return value

Report_GetResponseTimesResponsegetResponseTimesResponse

Response object of Report_getResponseTimes function. It contains field for status of the performed operation, and field for list of response time objects.

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Report_getResponseTimes xmlns:q1="urn:methods">
		<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
		<sessionId xsi:type="xsd:string">2a36f52ae385a1c77bbdb9f06af47eaa</sessionId>
		<getResponseTimesRequest href="#id1" />
	</q1:Report_getResponseTimes>
	<q2:Report_GetResponseTimesRequest id="id1" xsi:type="q2:Report_GetResponseTimesRequest" 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>
		<locations href="#id2" />
	</q2:Report_GetResponseTimesRequest>
	<soapenc:Array id="id2" soapenc:arrayType="xsd:string[0]" />
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:getResponseTimesResponse>
		<return xsi:type="ns2:Report_GetResponseTimesResponse">
			<status xsi:type="xsd:int">0</status>
			<responseTimesArray SOAP-ENC:arrayType="ns2:Report_ResponseTimeEntry[32]" xsi:type="ns2:ResponseTimesArray">
				<item xsi:type="ns2:Report_ResponseTimeEntry">
					<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>
					<responseTime xsi:type="xsd:float">0</responseTime>
				</item>
				<item xsi:type="ns2:Report_ResponseTimeEntry">
					<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>
					<responseTime xsi:type="xsd:float">0</responseTime>
				</item>
				<item xsi:type="ns2:Report_ResponseTimeEntry">
					<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>
					<responseTime xsi:type="xsd:float">0</responseTime>
				</item>


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


				<item xsi:type="ns2:Report_ResponseTimeEntry">
					<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>
					<responseTime xsi:type="xsd:float">0</responseTime>
				</item>
			</responseTimesArray>
		</return>
	</ns1:getResponseTimesResponse>
</SOAP-ENV:Body>