v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Score

Consumo dos scores agregado

Essa rota visa oferecer uma alternativa ao endpoint de respostas individuais, sendo compatível com instrumentos confidenciais, e com retorno já consolidado, pronto para uso em dashboards ou análises externas.

get/score/{uid_instrument}

Path parameters

uid_instrumentstring required

Identificador do instrumento a ser consultado. Esse parâmetro faz parte da URL do endpoint.

Query parameters

endDatestring

Example:2025-05-13T00:00:00.000Z

Data final do período de consulta. Se não for informada, será considerada a data atual. O formato deve ser YYYY-MM-DD. Para instrumentos em frequência não contínua (bimestral, trimestral, semestral, anual), esse campo será aplicado apenas nas resposta, não sendo considerado para a hierarquia (grupos e líderes).

idLeaderstring

ID do líder utilizado como filtro.

leaderHierarchyDepth'direct' | 'full'

Define o nível de profundidade hierárquica de lideranças a ser considerado no cálculo do score. Os valores podem ser "direct" para considerar apenas liderados diretos ou "full" para considerar toda a hierarquia abaixo, em todos os níveis. Caso não seja informado, o valor default é "direct".

idGroupstring

ID do grupo utilizado como filtro.

groupHierarchyDepth'direct' | 'full'

Define o nível de profundidade hierárquica de grupos a ser considerado no cálculo do score. Os valores podem ser "direct" para considerar apenas os respondentes do grupo ou "full" para considerar toda a hierarquia abaixo, em todos os níveis. Caso não seja informado, o valor default é "direct".

idQuestionstring

ID da questão utilizada como filtro.

Response

Sucesso

overallScorenumber float

Score do instrumento

Example response

{
  "instrument": {
    "uid": "9078e581-5148-11e8-86b6-1c394753aa54",
    "name": "Pulses",
    "laggingWeeks": 8
  },
  "overallScore": 7,
  "lagging": [
    {
      "score": 7.3,
      "respondentCount": 19,
      "startDate": "2025-04-20",
      "endDate": "2025-04-26",
      "previousDate": "2025-04-13",
      "previousWeek": 202515,
      "reason": "Número de respondentes mínimos não atingido"
    }
  ]
}