> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Dados de Progressão da Unidade

> Recupere os dados atualizados de progressão nos cursos de uma escola específica.

## Parâmetros

<ParamField path="school_id" type="string" required>
  Identificador da escola no sistema.
</ParamField>

<ParamField query="startDate" type="string">
  Data inicial do intervalo da consulta.
</ParamField>

<ParamField query="endDate" type="string">
  Data final do intervalo da consulta.
</ParamField>

<ParamField query="multiInst" type="boolean">
  Indica se a consulta deve considerar múltiplas instituições (valor esperado: "on").
</ParamField>

<ParamField query="cpf" type="string">
  CPF do usuário a ser consultado.
</ParamField>

<ParamField query="email" type="string">
  E-mail do usuário a ser consultado.
</ParamField>

<ParamField query="updatedAt" type="string">
  Data de atualização dos dados.
</ParamField>

<Note>Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro:</Note>

* **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.

<ResponseField name="data" type="object">
  Contém a lista paginada de usuários com estatísticas de progresso em cursos.

  <Expandable title="properties">
    <ResponseField name="current_page" type="number">
      Página atual da listagem.
    </ResponseField>

    <ResponseField name="data" type="array">
      Lista de registros de usuários.

      <Expandable title="items">
        <ResponseField name="user_id" type="number">
          Identificador único do usuário.
        </ResponseField>

        <ResponseField name="user_name" type="string">
          Nome completo do usuário.
        </ResponseField>

        <ResponseField name="user_email" type="string">
          Endereço de e-mail do usuário.
        </ResponseField>

        <ResponseField name="user_cpf" type="string">
          CPF do usuário (pode estar vazio).
        </ResponseField>

        <ResponseField name="course_name" type="string">
          Nome do curso ao qual o progresso pertence.
        </ResponseField>

        <ResponseField name="percentual_usage" type="number">
          Quantidade de conteúdos consumidos.
        </ResponseField>

        <ResponseField name="content_total" type="number">
          Total de conteúdos disponíveis no curso.
        </ResponseField>

        <ResponseField name="percentual_progress" type="string">
          Progresso percentual do curso (ex: "95%").
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>