Workflows

Retrieve workflow statistics

Execution counts by status, average completion time, the emails this workflow sent (with opens and clicks), and per-goal conversion counts. All-time by default — pass from to narrow it. Unlike /api/v1/analytics/* there is no 90-day ceiling here, because every aggregate is already confined to this one workflow.

The workflow's own name, enabled, trigger_type and step_count travel with the counts, because the counts alone are ambiguous: no running executions means one thing on an enabled workflow and another on a paused one.

Requires the workflows:read scope — View your automation workflows and their runs.

get/api/v1/workflows/{id}/stats

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}/stats
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:read)

Path parameters

idstring uuid required

Workflow id.

Query parameters

fromstring date-time nullable

Only count executions started at or after this instant (ISO 8601). Defaults to all time.

Response

Workflow statistics

avg_duration_msnumber nullable required
by_statusobject required

Execution counts keyed by status; a status with no executions is absent.

completion_ratenumber nullable required

Completed ÷ finished executions (0–1). Null until at least one execution has finished.

enabledboolean required
namestring required
step_countinteger required

Steps in the workflow's graph, trigger step included.

totalinteger required
trigger_type'EVENT' | 'MANUAL' | 'SCHEDULE' required

What starts a workflow. EVENT: a custom event you record. MANUAL: only an explicit API call. SCHEDULE: a fixed repeating interval.

workflow_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.