Dashboard

Os endpoints desta página atendem a aba Dashboard, da tela Relatórios. Eles devolvem os totais, os gráficos mensais e os rankings de vendas e de despesas dos treinamentos. Todos os endpoints aceitam os mesmos filtros, descritos abaixo. A geração de arquivos da aba Relatório está em Relatórios.

Endpoints

Método	Caminho	Descrição
GET	/comercial/reports/dashboards/totals	Totais de vendas, com e sem empresa.
GET	/comercial/reports/dashboards/monthly-sales	Vendas por mês, com e sem empresa.
GET	/comercial/reports/dashboards/monthly-expenses	Despesas das turmas por mês, com e sem empresa.
GET	/comercial/reports/dashboards/students	Matrículas que compõem o total de vendas.
GET	/comercial/reports/dashboards/top-ten-business	Dez empresas com maior valor de vendas.
GET	/comercial/reports/dashboards/top-ten-agents	Dez representantes com maior valor de vendas.
GET	/comercial/reports/dashboards/top-ten-courses	Dez cursos com maior valor de vendas.

Filtros

Os filtros são parâmetros de consulta, enviados na URL. Todos são opcionais. Sem filtro, o endpoint considera todos os treinamentos do cliente da sessão.

Parâmetro	Descrição
start_date e end_date	Período pela data de início dos treinamentos. Com os dois, considera o intervalo. Só com um deles, considera essa data.
year	Ano. Considera só os treinamentos que começam nesse ano.
month	Mês, de 1 a 12. Considera só os treinamentos que começam nesse mês.
course	Texto. Busca pelo nome ou pela sigla do curso.
business	Texto. Busca pelo nome ou pela razão social da empresa.
agent_id	Número. id do representante (usuário) do treinamento.
with_business	true ou false. true considera só treinamentos vinculados a empresa. false considera só treinamentos sem empresa. Sem o parâmetro, considera os dois.
per_page e page	Paginação. Só o endpoint students pagina a resposta.

Totais

GET /comercial/reports/dashboards/totals

Devolve os totais de vendas do período filtrado. O valor de vendas é a soma do valor das matrículas dos alunos.

Resposta

200, com um objeto com os campos:

Campo	Descrição
total_with_business	Total das matrículas vinculadas a empresa.
total_without_business	Total das matrículas sem empresa.
total	Soma dos dois campos anteriores.

Exemplo:

curl -G "https://api.pedagogo.app/comercial/reports/dashboards/totals" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-urlencode "year=2026"

Gráficos mensais

GET /comercial/reports/dashboards/monthly-sales

Devolve as vendas dos doze meses do ano, em ordem de janeiro a dezembro. Sem year, cada mês soma os treinamentos de todos os anos.

Resposta

200, com uma lista de doze itens. Cada item traz:

Campo	Descrição
month	Nome do mês.
with_business	Total das matrículas vinculadas a empresa.
without_business	Total das matrículas sem empresa.
total	Soma dos dois campos anteriores.

GET /comercial/reports/dashboards/monthly-expenses

Devolve as despesas das turmas dos doze meses do ano, com a mesma estrutura de monthly-sales. Cada valor soma as despesas das turmas dos treinamentos que atendem aos filtros.

Resposta

200, com uma lista de doze itens, com os campos month, with_business, without_business e total.

Matrículas e rankings

GET /comercial/reports/dashboards/students

Lista as matrículas que compõem o total de vendas, com os filtros acima. Aceita per_page e page. Sem per_page, a resposta é a lista direta.

Resposta

200, com cada item trazendo id, amount (valor da matrícula), student_name, start_date, course_name e business_name.

GET /comercial/reports/dashboards/top-ten-business

Devolve até dez empresas, em ordem decrescente do valor de vendas. Cada item traz business_name e total_amount.

GET /comercial/reports/dashboards/top-ten-agents

Devolve até dez representantes, em ordem decrescente do valor de vendas. Cada item traz id, agent_name e total_amount.

GET /comercial/reports/dashboards/top-ten-courses

Devolve até dez cursos, em ordem decrescente do valor de vendas. Cada item traz course_name, course_short_name e total_amount.