---
title: "Consumo dos scores agregado"
method: GET
path: "/score/{uid_instrument}"
tags: ["Score"]
---

# Consumo dos scores agregado

`GET /score/{uid_instrument}`

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.

## Path parameters

- `uid_instrument` string, required

## Query parameters

- `endDate` string
- `idLeader` string
- `leaderHierarchyDepth` 'direct' | 'full'
- `idGroup` string
- `groupHierarchyDepth` 'direct' | 'full'
- `idQuestion` string

## Response `200`

Sucesso

- object
  - `instrument` object
    - `uid` string, uuid
    - `name` string
    - `laggingWeeks` integer
  - `overallScore` number, float — Score do instrumento
  - `lagging` object[]
    - `score` number, float — Score do instrumento
    - `respondentCount` integer — Número de respondentes considerados no cálculo do score geral
    - `startDate` string, date — Data de início do período analisado. Pode ser ajustada em relação à data solicitada para refletir o início de uma semana.
    - `endDate` string, date — Data de término do período analisado. Pode ser ajustada em relação à data solicitada para refletir o final de uma semana.
    - `previousDate` string, date — Data de término do período anterior válido. Este campo é opcional e só aparece quando há um score anterior válido calculado.
    - `previousWeek` integer — Número da semana (year_week) do período anterior válido no formato YYYYWW. Este campo é opcional e só aparece quando há um score anterior válido calculado.
    - `reportable` boolean — Retorna "true" quando o score geral pode ser calculado conforme a regra mínima de respondentes. Caso contrário, "false".
    - `reason` string, nullable — Motivo para não ter sido reportado quando reportable é "false".

## Other responses

- `400` — Parâmetros inválidos. Cada parâmetro inválido estará dentro do objeto "errors".
- `404` — Filtro não encontrado

---

[API](https://skmtc.net/gupy/apis/gupy-public-api.md) · [All operations](https://skmtc.net/gupy/apis/gupy-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gupy/gupy-public-api/revisions/3f26defa2a42/schema)