Stats

Workflow funnel

The enrolment funnel for one workflow: entered → delivered → opened → clicked → converted, each with the drop from the stage before it.

The funnel counts distinct contacts; totals counts messages. A three-email drip sends three messages to one person, so a funnel counted in messages would report more delivered than entered and stop being a funnel at all. The two numbers differ for that reason, not by mistake.

Conversion is whatever you say it is. Volanea stores no conversion of its own — what counts as one is a property of your product. Name any event you already send to POST /v1/events as conversionEvent and it becomes the last stage. Only conversions that happened at or after the contact entered are counted; attributing a purchase that predates the enrolment would flatter every funnel aimed at people who already buy. Omit the parameter and the stage is absent rather than zero, because "no goal set" and "nobody converted" are different answers.

Engagement is aggregated from the send log on read rather than kept as counters on the workflow, so these numbers are real for workflows that ran long before this endpoint existed.

get/v1/workflows/{id}/stats

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/workflows/{id}/stats
  • Auth: HTTP bearer

Path parameters

idstring required

Workflow id.

Query parameters

daysinteger

Window length in days (1–365, default 30).

conversionEventstring

One of your own event names, e.g. order.placed. Adds the converted stage.

Response

The funnel.

workflowIdstring
namestring
statusstring
testModeboolean
executionsobject

Enrolment counts by execution status.

conversionEventstring

Echoed back when one was named.

Changes

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