Get Batch Statistics Count

Requests the number of batch statistics that fulfill the query criteria. Takes the same filtering parameters as the Get Batch Statistics method.

Method

GET /batch/statistics/count

Name	Description
batchId	Filter by batch id.
type	Filter by batch type. See the User Guide for more information about batch types.
tenantIdIn	Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids.
withoutTenantId	Only include batches which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior.
suspended	A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned.
createdBy	Only include batches that were started by this user id.
startedBefore	Only include batches that were started before the given date. By default*, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
startedAfter	Only include batches that were started after the given date. By default*, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
withFailures	Only include batches having jobs with failures. Value can only be `true`.
withoutFailures	Only include batches having jobs without failures. Also returns batches without jobs. Value can only be `true`.

* For further information, please see the documentation.

A JSON object that contains the count as the only property.

Name	Type	Description
count	Number	The number of matching batches.

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`. See the Introduction for the error response format.

GET /batch/statistics/count?type=aBatchType

Status 200.

{
  "count": 1
}