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

# Dashboard da Unidade

> Retorna os dados de consumo exibidos no dashboard da unidade desejada.

## Parâmetros

<ParamField path="school_id" type="string" required>
  Número identificador da escola.
</ParamField>

<Note>Antes de utilizar este endpoint, certifique-se de possuir o token de autorização.</Note>

## Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

<ResponseField name="data" type="object">
  Contém os dados estatísticos.

  <Expandable title="properties">
    <ResponseField name="consumeContent" type="array">
      Lista de conteúdos consumidos.
    </ResponseField>

    <ResponseField name="access" type="object">
      Estatísticas de acesso categorizadas por período de tempo.

      <Expandable title="properties">
        <ResponseField name="monthly" type="array">
          Dados de acesso mensal.

          <Expandable title="items">
            <ResponseField name="month" type="string">
              Nome do mês.
            </ResponseField>

            <ResponseField name="access" type="number">
              Quantidade de acessos no mês.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="daily" type="array">
          Dados de acesso diário.
        </ResponseField>

        <ResponseField name="hourly" type="array">
          Dados de acesso por hora.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="numbers" type="object">
      Resumo das principais métricas.

      <Expandable title="properties">
        <ResponseField name="responsibles" type="number">
          Quantidade de responsáveis.
        </ResponseField>

        <ResponseField name="teachers" type="number">
          Quantidade de professores.
        </ResponseField>

        <ResponseField name="students" type="number">
          Quantidade de alunos.
        </ResponseField>

        <ResponseField name="matriculations" type="number">
          Total de matrículas.
        </ResponseField>

        <ResponseField name="courses" type="number">
          Total de cursos.
        </ResponseField>

        <ResponseField name="classes" type="number">
          Total de turmas.
        </ResponseField>

        <ResponseField name="contents" type="number">
          Total de conteúdos.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

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