Relatório de indicações por membro
GET/api/referrals/report
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia 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 e moderador (e o SuperAdmin); financeiro e membro recebem 403. Por membro que indicou: `count` (indicações que contaram) e `lastReferredAt`, do que mais indicou para o que menos. `totals` traz quantos indicaram e quantas indicações houve. `from`/`to` (AAAA-MM-DD ou data e hora) limitam pela data da indicação. `format=csv` baixa todas as linhas (membro, id, indicações, última indicação), sem paginação.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
pagefacoltativo | query | integer | |
limitfacoltativo | query | integer | |
fromfacoltativo | query | string | |
tofacoltativo | query | string | |
formatfacoltativo | query | json | csv |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Risposte
| Codice | Descrizione |
|---|---|
200 | O relatório (ou o CSV). |
400 | Requisição inválida — falha de validação. |
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. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/referrals/report" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"