Query Statistic

Written by Daniel Chilcott Updated over a week ago

Query Statistic returns a set of statistics matching the specified criteria in either list or aggregate form.

Properties

StartDate

Type: String InputThe earliest date for which statistics should be retrieved. The date is represented as a string formatted as yyyy/MM/dd. In addition to absolute dates, relative dates are also supported. For example, the expression0/0/-1 will search back one day.

EndDate

Type: String InputThe latest date for which statistics should be retrieved. The date is represented as a string formatted as yyyy/MM/dd. In addition to absolute dates, relative dates are also supported. For example, the expression0/0/-1 will search back one day.

MatchGroup

Type: String InputThe Group within which to search for statistics. This is the value of the Group property specified when creating statistics with the Statistic or Bulk Statistic Nodes.

MatchKey

Type: String InputAn optional value that can be used to locate a single statistic by it's Key. If left blank, all results will be returned for the date range.

MatchStatus

Type: List InputUnknown - Only Unknown results will be returnedInProgress - Only InProgress results will be returnedWarning - Only Warning results will be returnedError - Only Error results will be returnedSuccess - Only Success results will be returnedAny - All results will be returned

Note that the ID is returned in the Result, and must be mapped with the IDs above.

Method

Type: List InputList - All the results will be returnedCountByValue - The results will be grouped by Value, and the number of results for that ValueCountByStatus - The results will be grouped by Status, and the number of results for that Status

Result

Type: Xml OutputThe results will be returned in Xml format. The format depends on the Method used.

Remarks

The ID of the Status fields will be returned in the result, and can be mapped with the IDs as indicated in the Match Status.

The DateTime is based on the local time of the Pod the site is running in. Refer to the the Pod article for the time offset of the Pods.