GET workflows/metrics.json

zuora.com

Summary: Retrieve workflow task usage
Operation ID: GET_WorkflowsUsages
Auth: unknown
Description

Gets workflow task usage sorted by day within a specified time frame.

Parameters (6)

Authorization (string, header, required)

`Bearer {token}` for a valid OAuth token.

Zuora-Entity-Ids (string, header, optional)

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Track-Id (string, header, optional)

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).

Constraints: {'maxLength': 64}

endDate (string, query, required)

The end date of the usage data that you want to get. For example, 2019-12-31.

metrics (string, query, required)

The type of metric that you want to get. Currently, only `taskCount` is supported. `taskCount` is the amount of task runs.

startDate (string, query, required)

The start date of the usage data that you want to get. For example, 2019-01-01.

No probe data for this endpoint yet.