Saltar al contenido

Números de Feedbacks no período (sem nenhum texto)

GET/api/feedbacks/dashboard

Auth
Requiere token
Clave de API:
No acepta clave de API
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 e admin (membro, moderador e financeiro: 403). Só números, nunca texto, autor ou destinatário. No período `from`..`to` (dias `AAAA-MM-DD` no fuso da comunidade; padrão os últimos 30 dias até hoje; no máximo 366): `feedbacksGiven` (espontâneos + respostas, sem os apagados), `spontaneous`, `answers`; `requests` feitos no período e onde cada um está hoje (`pending`, `answered`, `declined`, `canceled`); e a adesão: `peopleWithAccess` (quem abre o espaço hoje), `peopleWhoGave` (delas, quantas deram ao menos um no período) e `adoptionPercent`. Com `groupId` (grupo da comunidade, membros diretos): só os feedbacks e pedidos em que alguém do grupo está de um dos lados, e a adesão entre as pessoas do grupo. Com `spaceId`, só um espaço de Feedbacks (a adesão entre quem abre esse espaço); sem ele, todos os espaços (quem abre algum deles). `byTheme`: por tema do catálogo (ativo, ou com contagem no período), quantos feedbacks e pedidos o usaram e, dentro dele, por comportamento; só contagens, nunca texto nem pessoa, com o mesmo período, grupo e espaço. Contagem de 1 ou 2 vem `null` (abaixo de `byThemeMinCount`, 3), para o tema não apontar a pessoa; e, se num conjunto (os temas, ou os comportamentos de um tema) só uma ficou escondida, a menor visível também vem `null`, para a escondida não ser deduzida das outras. Com `groupId`, `byTheme` vem `null`: por tema, só a comunidade ou o espaço, no período. `byKind` divide os números em `direct` (feedbacksGiven, spontaneous, answers, requests, pending, answered, declined, canceled) e `about`, feedback sobre outra pessoa (feedbacksGiven, spontaneous, answers, withMessage, withoutMessage, rounds = pedidos, nominees = indicados, pending, answered, declined, canceled); com `groupId`, conta também quando a pessoa sobre quem é está no grupo.

Parámetros

NombreDóndeTipoDescripción
fromopcionalquerystring (date)
toopcionalquerystring (date)
groupIdopcionalquerystring (uuid)
spaceIdopcionalquerystring (uuid)Um espaço de Feedbacks; sem ele, todos.

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
200`{ from, to, timeZone, groupId, spaceId, feedbacksGiven, spontaneous, answers, requests, pending, answered, declined, canceled, peopleWithAccess, peopleWhoGave, adoptionPercent, byKind: { direct, about }, byTheme: [{ themeId, name, active, feedbacks, requests, behaviors: [{ behaviorId, name, active, feedbacks, requests }] }], byThemeMinCount }` (contagens de tema abaixo de 3, e a menor visível ao lado de uma única escondida, vêm `null`; com `groupId`, `byTheme` é `null`).
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.
422Data inválida, `to` antes de `from`, período acima de 366 dias ou grupo de outra comunidade.
500Erro interno do servidor.

Ejemplo con curl

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