Skip to content

Números do Reconhecimento no período

GET/api/recognitions/dashboard

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

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.

Parameters

NameInTypeDescription
fromoptionalquerystring (date)
tooptionalquerystring (date)
spaceIdoptionalquerystring (uuid)Um espaço de Reconhecimento; sem ele, todos.

Headers

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

Responses

StatusDescription
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.
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` ou período acima de 366 dias.
500Erro interno do servidor.

curl example

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