Dashboard
O Dashboard mostra os totais e os gráficos dos documentos de assinatura da empresa. A mesma tela gera os relatórios em Excel. Os totais e gráficos respeitam os filtros aplicados.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /digital-signature/dashboard/reports | Lista os relatórios disponíveis |
| GET | /digital-signature/dashboard/reports/generate | Gera um relatório em Excel |
| GET | /digital-signature/dashboard/charts/totals | Totais dos painéis |
| GET | /digital-signature/dashboard/charts/documents-by-month | Quantidade de documentos nos últimos 12 meses |
| GET | /digital-signature/dashboard/charts/documents-by-status | Quantidade de documentos por status |
| GET | /digital-signature/dashboard/charts/documents-by-month-status | Quantidade por mês e por status |
| GET | /digital-signature/dashboard/documents | Documentos que atendem aos filtros |
| GET | /digital-signature/dashboard/filters/users | Usuários que cadastraram documentos |
| GET | /digital-signature/dashboard/filters/statuses | Status, para o filtro |
Filtros
Os endpoints de totais, gráficos, documentos e relatórios aceitam os mesmos parâmetros de URL:
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| user_create_id | Não | Id do usuário que cadastrou o documento. Os ids vêm de GET /digital-signature/dashboard/filters/users |
| status_id | Não | Id do status. Para vários, repita o parâmetro. Os ids vêm de Status |
| start_date | Não | Início do período de cadastro |
| end_date | Não | Fim do período de cadastro |
Totais
GET /digital-signature/dashboard/charts/totals
Resposta (200):
| Campo | Descrição |
|---|---|
| total_month | Documentos cadastrados no mês corrente |
| total | Total de documentos |
| total_pending | Documentos em Aguardando assinatura, Aberto ou Assinatura parcial |
| total_waiting_for_signing | Documentos com status 1 (Aguardando envio) |
| total_concluded | Documentos com status 4 (Assinatura concluída) |
| total_declined | Documentos com status 5 (Recusado) |
| total_canceled | Documentos com status 6 (Cancelado) |
| total_expired | Documentos com status 7 (Expirado) |
Gráficos
GET /digital-signature/dashboard/charts/documents-by-month
Quantidade de documentos cadastrados em cada um dos últimos 12 meses, do mais antigo ao mais recente.
Resposta (200): lista de itens com month (abreviação do mês), monthNumber,
year e total.
GET /digital-signature/dashboard/charts/documents-by-status
Quantidade de documentos por status.
Resposta (200): objeto em que a chave é o nome interno do status (por
exemplo, Waiting for sending) e o valor é a quantidade.
GET /digital-signature/dashboard/charts/documents-by-month-status
Quantidade de documentos por mês e por status, nos últimos 12 meses.
Resposta (200): lista com um item por mês, com month, monthNumber, year,
e uma chave para cada status (pelo nome interno), com a quantidade.
Documentos
GET /digital-signature/dashboard/documents
Lista os documentos que atendem aos filtros, com as relações de status, usuário que cadastrou e destinatários.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| per_page | Não | Quantidade de registros por página. Sem ele, a resposta é a lista simples |
| page | Não | Número da página, quando per_page é informado |
Resposta (200): lista de documentos, ou paginação padrão quando per_page é informado.
Relatórios
GET /digital-signature/dashboard/reports
Resposta (200): lista com os dois relatórios disponíveis:
| Id | Nome | Conteúdo |
|---|---|---|
| 1 | Documents for Signature | Documentos que atendem aos filtros: número, título, pasta, data de expiração, status, usuário que cadastrou e data de criação |
| 2 | Unsigned Documents Recipients | Destinatários que ainda não assinaram: dados do documento, nome, e-mail, celular, data de abertura, data de assinatura e link de assinatura |
GET /digital-signature/dashboard/reports/generate
Gera o relatório escolhido em Excel, respeitando os filtros informados.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| report_id | Sim | Id do relatório: 1 ou 2. Veja a lista em GET /digital-signature/dashboard/reports |
Além de report_id, aceita os filtros descritos na seção Filtros, no início desta página.
Resposta (200): arquivo .xlsx para download.
curl "https://api.pedagogo.app/digital-signature/dashboard/reports/generate?report_id=1&start_date=2026-01-01&end_date=2026-03-31" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-o relatorio-documentos.xlsx
Filtros de seleção
GET /digital-signature/dashboard/filters/users
Lista os usuários que cadastraram documentos da empresa, com id e name. Use o
id no filtro user_create_id.
Resposta (200): lista de usuários.
GET /digital-signature/dashboard/filters/statuses
Lista os status, com id e status. É a mesma resposta de
GET /digital-signature/documents/statuses.
Resposta (200): lista de status.