Aller au contenu

Relatório de eventos (inscritos e interessados)

GET/api/reports/events

Auth
Jeton requis
Clé d’API:
reports:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin, moderador ou financeiro.

**Por tipo de ingresso:** cada evento traz `ticketTypes` (`ticketTypeId`, `name` (`null` = o tipo padrão "Ingresso"), `tickets` ativos e `checkedIn`), sem valores.

**Presença:** evento com check-in ligado (`checkInEnabled`) traz `attended`, quantos fizeram check-in (na porta, no quiosque, por cortesia ou pela transmissão ao vivo); sem check-in, `attended` vem `null`. `attendanceTracked` é `true` quando algum evento da janela usa check-in, e `totals.attended` soma só esses eventos. Além disso, a resposta de cada pessoa: `going` (vou), `maybe` (talvez) e `notGoing`.

`series[]` por período: `events` (eventos que começam no período) e as respostas registradas no período. `events[]` (paginada) traz os eventos da janela, pela data de início (ou de criação, sem data), com as respostas e o link.

Paramètres

NomEmplacementTypeDescription
intervalfacultatifqueryday | week | monthTamanho de cada período da série. `week` começa na segunda-feira. Rótulo do período: `YYYY-MM-DD` (dia ou segunda-feira da semana) ou `YYYY-MM` (mês). Máximo de períodos por consulta: 366 dias, 156 semanas ou 120 meses.
fromfacultatifquerystring (date)Primeiro dia (inclusive), no fuso do relatório, alargado para o início do período (com `interval=month`, `2026-03-15` vira `2026-03-01`). Padrão: 30 dias, 12 semanas ou 12 meses antes de `to`.
tofacultatifquerystring (date)Último dia (inclusive), alargado até o fim do período. Padrão hoje.
timezonefacultatifquerystringFuso IANA em que os períodos são contados. Padrão: o fuso do país da comunidade (o mesmo dos prazos do call4papers). A resposta devolve o fuso usado em `timezone`.
pagefacultatifqueryintegerPágina da lista detalhada (membros, eventos ou cursos).
limitfacultatifqueryintegerItens por página da lista detalhada.

En-têtes

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

Réponses

StatutDescription
200Série e lista de eventos; `pagination` vale para `events`.
400Requisição inválida — falha de validação.
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.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/reports/events" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"