Viewing flow metrics by using APIs

As a Tenant administrator, you have the option to view flow metrics by using the flow-metrics API. The API returns the following metrics data:

  • Average number of records processed
  • Max number of records
  • Max time for a flow run
  • Average time for a flow run

To view the metrics, run the following command:

  • By providing the short name of the tenant:
    GET api/v1.0/reports/flow-metrics?shortName=<tenantShortName>&start-date=2023-02-06&end-date=2023-09-07
  • By providing flow ID and date range:
    GET api/v1.0/reports/flow-metrics?flowId=<flowID>&start-date=2023-02-06&end-date=2023-09-07

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*