The urlinsightGetUrls Web API Method

Get a list of URL statistics.

Version: 1.9

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

limit

integer

No

The number of rows to retrieve. Default lists all rules up to an arbitrary limit set by the system.

offset

integer

No

A paging offset to begin the list from. Default: 0

applicationId

integer

No

Display URLs of a specific application. If not supplied, or '0' given, display URLs from all the applications.

filter

integer

No

Predefined filters/order

1 - “most time consuming” - order by number of samples multiply average time, descending.

2 - “slowest response time” - order by average time, descending.

3 - “most visited” - ordered by number of sample,s descending.

If not supplied, default is 1.

period

integer

No

Period in hours (one week is 24*7, etc.)

Default is 24.

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: urlinsightUrlsList

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request

GET /ZendServer/Api/urlinsightGetUrls

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.8">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>urlinsightGetUrls</method>

</requestData>

<responseData>

<totalCount>16</totalCount>

<totalTimeConsumption>116693360</totalTimeConsumption>

<urls>

<url>

<resourceId>2</urlId>

<url><![CDATA[...]]></url>

<samples>23</status>

<minTime>...</minTime>

<maxTime>...</maxTime>

<avgTime>...</avgTime>

<maxMemory>...</maxMemory>

<avgMemory>...</avgMemory>

<fromTime>...</fromTime>

<untilTime>...</untilTime>

</url>

...

</urls>

</responseData>

</zendServerAPIResponse>