Relatório de indicações por membro
GET/api/referrals/report
- Auth
- Requiere token
- X-CommunityId
X-CommunityIdEnví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 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.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
pageopcional | query | integer | |
limitopcional | query | integer | |
fromopcional | query | string | |
toopcional | query | string | |
formatopcional | query | json | csv |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/referrals/report" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"