Event Measure Parameters

Each event measure operation returns a different type of measure.

However, all of the event measure operations expect the same parameters in the request, as follows:

  • Process Template IDs - One or more process templates must be identified, which causes either process instance or work item statistics for each of the process templates to be returned.
  • Start and End Date - The total period of time encompassed by the statistical data returned (which is further broken down into periods, as specified by the granularity parameter—see below).
  • Granularity - The period of time (hour, day, week, etc.) for which each piece of statistical data is returned (for example, number of process instances whose state was changed to "Suspended" during a particular month).
  • Consolidation - Allows you to specify whether statistical data should be returned for each specified process, or consolidated, or both individually and consolidated.

These parameters are described in more detail in the following subsections.