The urlinsightGetUrlInfo Web API Method

Get a single request statistics info with its requests. The requests can be filtered and ordered using 'period' and 'order' parameter

Version: 1.9

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

id

Integer

Yes

The URL ID to retrieve the info from.

order

String

No

The order of the requests list. The format is like in 'order' clause in SQL, e.g. ‘from_time desc’ or ‘until_time’.

period

Integer

No

Number of hours. Limits the requests list to a specific period - 'period' hours back until now. Default is 24 (i.e. by default bring requests from the last 24 hours).

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

Response Format: urlinsightRequestInfo

Possible Action Specific Error Codes:

HTTP Code

 Error Code

Description

404

urlinsightNoSuchUrl

The URL does not exist.

Example

Usage Example

Request

GET /ZendServer/Api/urlinsightGetUrlInfo?id=2

Response

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

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

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>urlinsightGetUrlInfo</method>

</requestData>

<responseData>

<url>urlinsightUrl</url>

<requests>

<request>urlinsightRequest</request>

...

</requests>

</responseData>

</zendServerAPIResponse>