Estimativa de público antes de ligar

GET/api/workflows/{id}/estimate

Auth: Requires a token
API key:: workflows:read
X-CommunityId: X-CommunityId Send the X-CommunityId of the community the operation happens in.

Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner, admin, moderador e financeiro; só leitura. Quantas pessoas diferentes dispararam o gatilho do workflow (com o filtro dele) no último dia, nos últimos 7 e nos últimos 30 dias: a estimativa de quantas entrariam em cada período. Com vários gatilhos, todos contam e cada pessoa uma vez só (os de evento em `last*`, os por tempo em `today`). O que um workflow causou não conta. Num gatilho por tempo, `people.today` diz quantas pessoas a passada de hoje pegaria (os outros vêm `null`); em `time.no_access`, `people.existing` diz quantas já passaram dos N dias e entrariam com `includeExisting: true` (`null` nos outros gatilhos). A conta é guardada por 5 minutos (`cachedForSeconds`); `capped` fica sempre `false`. Até 30 estimativas por hora por pessoa (429 com `Retry-After`).

Parameters

Name	In	Type	Description
`id`required	path	`string (uuid)`

Headers

Name	Type	Description
`X-CommunityId`optional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

Status	Description
`200`	A estimativa.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`404`	Recurso não encontrado.
`429`	Mais de 30 estimativas na hora; `Retry-After` diz quando tentar de novo.
`500`	Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/workflows/<id>/estimate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"