BCDR Cloud API icon

BCDR Cloud API

BCDR Company Cloud API integration for business communications

Actions90

Flow → Get Flow Metrics

AI-generated

Summary

Retrieve specified metrics for a given Flow over a defined time range with chosen granularity.

Inputs

  • Flow ID (required) — Unique identifier of the Flow to retrieve metrics for.
  • Metric Name (required) — Type of flow metric to fetch: Opens, Completions, or Errors.
  • Granularity (required) — Time granularity for metrics aggregation: Daily, Weekly, or Monthly.
  • Since Date — Optional start date to begin the metrics data range.
  • Until Date — Optional end date to end the metrics data range.

Output shape

a JSON object containing the requested metric data aggregated by the specified granularity within the given date range for the Flow.

The response includes metrics data corresponding to the selected metric name and respects the date filters if provided; unspecified dates imply default or full range as per API. No pagination is indicated.

Links

Discussion