Skip to main content
GET
/
api
/
reports
/
school
/
{school_id}
/
percentage
Dados de Progressão da Unidade
curl --request GET \
  --url https://kong.api.toolzz.com.br/api/reports/school/{school_id}/percentage \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "current_page": 123,
    "data": [
      {
        "user_id": 123,
        "user_name": "<string>",
        "user_email": "<string>",
        "user_cpf": "<string>",
        "course_name": "<string>",
        "percentual_usage": 123,
        "content_total": 123,
        "percentual_progress": "<string>"
      }
    ]
  }
}

​
Parâmetros

​
school_id
string
required
Identificador da escola no sistema.
​
startDate
string
Data inicial do intervalo da consulta.
​
endDate
string
Data final do intervalo da consulta.
​
multiInst
boolean
Indica se a consulta deve considerar múltiplas instituições (valor esperado: “on”).
​
cpf
string
CPF do usuário a ser consultado.
​
email
string
E-mail do usuário a ser consultado.
​
updatedAt
string
Data de atualização dos dados.
Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro:
  • school_id é obrigatório: número identificador da unidade, que deverá ser passado na URL da requisição.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
​
data
object
Contém a lista paginada de usuários com estatísticas de progresso em cursos.