Statistics - Query

Description

The query action runs a predefined report against the statistics data, all reports return JSON and the following query types are supported:

• items - Lists the statistics that have been reported to the statistics module for the specified module and group, ordered by date descending
  An array of JSON objects is returned with the following fields:
  
  

  JSON field name	Description
  duration	The number of milliseconds it took to process the data
  numberFailed	The number of items that failed processing
  numberProcessed	The number of records that were processed
  numberSuccessful	The number of records that were successfully processed
  statisticsDate	The date and time the run started (UTC)



• slowest - Lists the statistics where the duration for a single record is greater than that specified, ordered by duration for a single record, ordered by duration descending
  An array of JSON objects is returned with the following fields:
  
  

  JSON field name	Description
  duration	The number of milliseconds it took to process the data
  numberFailed	The number of items that failed processing
  numberProcessed	The number of records that were processed
  numberSuccessful	The number of records that were successfully processed
  statisticsDate	The date and time the run started (UTC)



• status - Returns a summary of the statistics for the number of days specified
  A JSON object is returned with the following fields:
  
  

  JSON field name	Description
  duration	The total number of milliseconds processing took
  numberFailed	The total number of items that failed
  numberProcessed	The total number of records that were processed
  numberSuccessful	The total number of records that were successfully processed
  fastestTime	The fastest time it took to process 1 record
  slowestestTime	The slowest time it took to process 1 record
  averageTime	The average time it took to process 1 record



• statusByDay - Returns a summary of statistics per day for the number of days specified
  An array of JSON objects is returned with the following fields:
  
  

  JSON field name	Description
  date	The date the statistics are for (format: YYYYMMDD)
  duration	The total number of milliseconds processing took
  numberFailed	The total number of items that failed
  numberProcessed	The total number of records that were processed
  numberSuccessful	The total number of records that were successfully processed
  fastestTime	The fastest time it took to process 1 record
  slowestestTime	The slowest time it took to process 1 record
  averageTime	The average time it took to process 1 record

Parameters

Parameters	Description	Used by Query Type
days	The The number of days that the status should cover (default: 30)	statusByDay status
duration	The minimum number of milliseconds it took to process 1 record that you are interested in (default: 0)	items slowest
limit	The maximum number of records to be returned (default: 100)	items slowest
offset	Where in the result set do you want results to be returned from (default: 0)	items slowest

Responses

The response will always be in JSON unless there is an error, in which case a http status 400 will be returned

Testing

In order to allow simple testing of the ECK Statistic interface. a test form is available here which performs actions against the default modules default group.