The monitorGetIssuesByPredefinedFilter Web API Method

Retrieve a list of monitor issues according to a preset filter identifier. The filter identifier is shared with the UI's predefined filters. This WebAPI method may also accept ordering details and paging limits.

The response is a list of issue elements with their general details and event-groups identifiers.

Version: 1.2

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

filterId

String

Yes

The predefined filter's name. This parameter is case-sensitive.

limit

Integer

No

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

offset

Integer

 

No

 

A paging offset to begin the issues list from. Default is 0

order

String

No

 

Column identifier for sorting the result set (id, name, repeats, date, eventType, fullUrl, severity, status). Default is date.

direction

String

No

 

Sorting direction: Ascending or Descending. Default is Descending

filters

Array

No

Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:

  • applicationIds: array, a list of application IDs to use for retrieving issue rows

  • severities: array, a list of severities (info, normal, severe)

  • statuses: array, a list of statuses (open, closed, reopened, ignored) - Removed in version 1.3.

  • eventTypes:array, a list of eventTypes (zend-error, function-error, request-slow-exec, function-slow-exec, request-relative-slow-exec, java-exception, request-large-mem-usage, request-relative-large-mem-usage, request-relative-large-out-size, jq-job-exec-error, jq-job-logical-failure, jq-job-exec-delay, jq-daemon-high-concurrency, tracer-write-file-fail, zsm-node-added-successfully, zsm-node-enabled, zsm-node-disabled, zsm-node-removed-successfully, zsm-node-is-not-responding, zsm-configuration-mismatch, zsm-restart-failed, zdd-deploy-success, zdd-deploy-error, zdd-redeploy-success, zdd-redeploy-error, zdd-remove-success, zdd-remove-error, zdd-update-success, zdd-update-error, zdd-rollback-success, zdd-rollback-error, custom

  • freeText: string

  • from: string, a timestamp to use for retrieving rows

  • to: string, a timestamp to use for retrieving rows

  • ruleNames: array, a list of rule names that are defined in the system: Function Error, Database Error, Slow Function Execution, Slow Query Execution, Slow Request Execution, High Memory Usage, Inconsistent Output Size, PHP Error, Uncaught Java Exception, Custom Event, Zend Framework Exception, Job Execution Error, Job Logical Failure, Job Execution Delay, Failed Writing Code Tracing Data and other custom names

  • fullUrl: string, represent the exact url string for the event. Added in WebApi 1.9.

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

Response Format: Response successful message or error message

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

404

noSuchFilterId

The requested filter does not exist

Example

Usage Example

Request

GET /ZendServer/Api/monitorGetIssuesByPredefinedFilter?filterId=All+Issues&limit=20&offset=0&order=date&direction=DESC

Response

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

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

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>monitorGetIssuesByPredefinedFilter</method>

</requestData>

<responseData>

<issues>

<issue>

<id>11</id>

<rule>PHP Error</rule>

<count>1</count>

<lastOccurance>18-Nov-2012 22:23</lastOccurance>

<severity>Warning</severity>

<status>Open</status>

<hasCodetracing>false</hasCodetracing>

<generalDetails>

<url>http://localhost/test.php</url>

<sourceFile>/var/www/test.php</sourceFile>

<sourceLine>302</sourceLine>

<function>fopen</function>

<aggregationHint>123412341234</aggregationHint>

<errorString>Permission Denied</errorString>

<errorType>E_WARNING</errorType>

</generalDetails>

<whatHappenedDetails>

<eventsGroupId>27</eventsGroupId>

<eventsCount>1</eventsCount>

<startTime>2013-05-09T14:07:57+03:00</startTime>

<startTimeTimestamp>1368097677</startTimeTimestamp>

<serverId>0</serverId>

<class></class>

<hasCodetracing>false</hasCodetracing>

<userData><![CDATA[]]></userData>

<javaBacktrace><![CDATA[]]></javaBacktrace>

<execTime>0</execTime>

<avgExecTime>0</avgExecTime>

<relExecTime>0</relExecTime>

<memUsage>0</memUsage>

<avgMemUsage>0</avgMemUsage>

<relMemUsage>0</relMemUsage>

<avgOutputSize>0</avgOutputSize>

<relOutputSize>0</relOutputSize>

<load>0</load>

</whatHappenedDetails>

<appName>Wordpress</appName>

<appId>12<appId>

<routeDetails>

<routeDetail>

<key>controller</key>

<value>test</value>

<routeDetail>

</routeDetails>

</issue>

</issues>

</responseData>

</zendServerAPIResponse>