Vai al contenuto

Resumo dos resultados do workflow

GET/api/workflows/{id}/summary

Auth
Richiede un token
Chiave API:
workflows:read
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

Owner, admin, moderador e financeiro (só leitura). Execução que chega a "Fim: sucesso" (ou a um ramo solto de um desenho antigo) é `COMPLETED`; a que chega a "Fim: erro", ou falha numa ação sem saída de erro, é `FAILED`. `last7Days` e `last30Days`: `completed`, `failed`, `successRate` (percentual, null sem execuções), `skippedSteps` (passos pulados por impedimento permanente: descadastro, bounce, sem e-mail, bloqueio, consentimento) e `errorLogs` (linhas do bloco "Registrar log" com nível error). `waitingForQuota`: passos aguardando cota agora. `alreadyRunning`: eventos dos últimos 30 dias que chegaram com a pessoa no meio de uma execução. `lastErrors`: as 10 últimas execuções com erro (passo, tipo, fim e motivo). Pulados, adiados e logs não contam para o aviso de taxa de erro (mais de 20% com pelo menos 20 execuções em 24 h: sino e e-mail a owner e admin, no máximo um por dia por workflow). O mesmo resumo vem em `GET /api/workflows/{id}` (`summary`).

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)

Header

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

Risposte

CodiceDescrizione
200O resumo.
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.
500Erro interno do servidor.

Esempio con curl

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