Skip to main content
GET
Consultar métricas do flow

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Parâmetros de caminho

flow_id
string
obrigatório

ID público do flow.

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

Parâmetros de consulta

since
string<date-time>

Início da janela analisada. O padrão são 30 dias atrás.

until
string<date-time>

Fim da janela analisada. O padrão é o instante da consulta.

Resposta

Métricas do flow no período.

object
string
obrigatório
Allowed value: "flow_metrics"
flow_id
string
obrigatório
Pattern: ^flw_[A-Za-z0-9_-]+$
eligibility
enum<string>
obrigatório
Opções disponíveis:
recovery,
engagement_only
since
string<date-time>
obrigatório
until
string<date-time>
obrigatório
attribution
object
obrigatório
entries
integer
obrigatório
Intervalo obrigatório: x >= 0
sent
integer
obrigatório
Intervalo obrigatório: x >= 0
delivered
integer
obrigatório
Intervalo obrigatório: x >= 0
failed
integer
obrigatório
Intervalo obrigatório: x >= 0
conversions
integer
obrigatório
Intervalo obrigatório: x >= 0
conversion_rate
number | null
obrigatório
revenue_in_cents
integer
obrigatório
average_ticket_in_cents
integer
obrigatório
nodes
object[]
obrigatório