Números do Reconhecimento no período

GET/api/recognitions/dashboard

Auth: Token erforderlich
API-Schlüssel:: Kein API-Schlüssel möglich
X-CommunityId: X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.

Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Owner e admin. 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 dias): `recognitions` feitos, `givers` (quantas pessoas reconheceram alguém) e `recipients` (quantas foram reconhecidas). Reconhecimento apagado não conta. `spaceId` restringe a um espaço de Reconhecimento; sem ele, os números somam todos os espaços da comunidade.

Parameter

Name	Ort	Typ	Beschreibung
`from`optional	query	`string (date)`
`to`optional	query	`string (date)`
`spaceId`optional	query	`string (uuid)`	Um espaço de Reconhecimento; sem ele, todos.

Header

Name	Typ	Beschreibung
`X-CommunityId`optional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Antworten

Status	Beschreibung
`200`	`{ from, to, timeZone, spaceId, recognitions, givers, recipients, byValue: [{ valueId, name, active, recognitions, topPeople: [{ person, count }] }], topPeoplePerValue }` (`spaceId` null = todos os espaços). `byValue`: por valor da comunidade (ativos sempre; inativos só com reconhecimentos no período) e, por último, `valueId: null` (sem valor); `topPeople` são as até 5 pessoas mais reconhecidas naquele valor no período.
`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.
`404`	Recurso não encontrado.
`422`	Data inválida, `to` antes de `from` ou período acima de 366 dias.
`500`	Erro interno do servidor.

curl-Beispiel

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