Skip to main content
GET
Get flow metrics

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Path Parameters

flow_id
string
required

Public flow ID.

Pattern: ^flw_[A-Za-z0-9_-]+$

Query Parameters

since
string<date-time>

Start of the analyzed window. Defaults to 30 days ago.

until
string<date-time>

End of the analyzed window. Defaults to the moment of the request.

Response

Flow metrics for the period.

object
string
required
Allowed value: "flow_metrics"
flow_id
string
required
Pattern: ^flw_[A-Za-z0-9_-]+$
eligibility
enum<string>
required
Available options:
recovery,
engagement_only
since
string<date-time>
required
until
string<date-time>
required
attribution
object
required
entries
integer
required
Required range: x >= 0
sent
integer
required
Required range: x >= 0
delivered
integer
required
Required range: x >= 0
failed
integer
required
Required range: x >= 0
conversions
integer
required
Required range: x >= 0
conversion_rate
number | null
required
revenue_in_cents
integer
required
average_ticket_in_cents
integer
required
nodes
object[]
required