WebAPI Reference Guide > Available API Methods > Statistics Methods > The statisticsGetSeries Method

The statisticsGetSeries Method

Retrieve a series of data according to a counter type identifier. The series retrieved is an aggregate of statistical information provided by Zend Server’s various components during execution.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

type

Enum

Yes

One of:

OPLUS_UTILIZATION

OPLUS_HITS

OPLUS_MISSES

OPLUS_FILES_CONSUMPTION

OPLUS_MEMORY_CONSUMPTION

OPLUS_MEMORY_WASTED

DC_SHM_UTILITZATION

DC_SHM_HITS

DC_SHM_MISSES

DC_DISK_HITS

DC_DISK_MISSES

DC_NUM_OF_NAMESPACES

DC_SHM_NUM_OF_ENTRIES

PC_NUM_OF_RULES

PC_HITS_PER_RUL

PC_MISSES_PER_RULE

PC_AVG_PROC_TIME_NON_CACHED_PAGE

PC_AVG_PROC_TIME_CACHED_PAGE

PC_NON_HANDLED_REQUESTS

JQ_JOBS_PER_STATUS

JQ_JOBS_ENQUEUED

JQ_JOBS_SCHEDULED_ENQUEUED

JQ_JOBS_DEQUEUED

SC_SESSIONS_CREATED

SC_SESSIONS_REUSED

SC_AVG_SESSION_SIZE

SC_MIN_SESSION_SIZE

SC_MAX_SESSION_SIZE

SC_SESSIONS_PER_APP

SC_SESSIONS_DATA_SPACE

MON_NUM_OF_EVENTS

NUM_REQUESTS_PER_SECOND

NUM_PHP_WORKERS

AVG_REQUEST_PROCESSING_TIME

MAX_REQUEST_PROCESSING_TIME

MIN_REQUEST_PROCESSING_TIME

AVG_REQUEST_PROCESSING_TIME_PER_APP

AVG_MEMORY_USAGE

AVG_CPU_USAGE

AVG_REQUEST_OUTPUT_SIZE

AVG_DATABASE_TIME

appId

Integer

No

Filter statistics by the specified application id.

Filtering by a particular application id still retrieves “global” statistic counters’ data. Default: all applications’ data

from

Timestamp

No

Unix timestamp of the start date timestamp

to

Timestamp

No

Unix timestamp of the end date

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

Response Format: Response successful message or error message

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

Example

Usage Example

Request

GET /ZendServer/Api/statisticsGetSeries?type=AVG_CPU_USAGE
Content-type: application/x-www-form-urlencoded

Repsonse

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>statisticsGetSeries</method>
	</requestData>
	<responseData>
		<series>
			<title>CPU Usage</title>
			<yTitle>CPU usage</yTitle>
			<valueType>%</valueType>
			<name>CPU Usage</name>
			<data>
				<i ts=”1234”>12</i>
				<i ts=”1234”>12</i>
				<i ts=”1234”>12</i>
				<i ts=”1234”>12</i>
				<i ts=”1234”>12</i>
				.
				.
				.
			</data>
		</series>
	</responseData>

 

 

 

Related Links

Related Links:

Available API Methods

 

 

 

 

© 1999-2013 Zend Technologies, Ltd. All rights reserved.