Saltar al contenido

Estimativa de público antes de ligar

GET/api/workflows/{id}/estimate

Auth
Requiere token
Clave de API:
workflows:read
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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`).

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

CódigoDescripción
200A estimativa.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
429Mais de 30 estimativas na hora; `Retry-After` diz quando tentar de novo.
500Erro interno do servidor.

Ejemplo con curl

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