Obter métricas do dashboard

GET

/api/v1/obrigacoes/dashboard

Última modificação:2026-02-24 18:28:37

Retorna métricas agregadas sobre obrigações para visualização no dashboard.

Métricas incluídas:

totalObrigacoes: Total de obrigações (todas)

totalPendentes: Total de obrigações pendentes

totalEnviadas: Total de obrigações enviadas

totalVencidas: Total de obrigações vencidas

totalProximasVencimento: Obrigações que vencem nos próximos 7 dias

totalObrigacoesAtivas: Total de obrigações ativas no sistema

totalClientesComObrigacoes: Total de clientes com obrigações configuradas

obrigacoesPorDepartamento: Distribuição de obrigações por departamento

obrigacoesPorStatus: Distribuição de obrigações por status

taxaCumprimento: Percentual de entregas enviadas no prazo (0-100)

Todas as métricas são calculadas para o tenant do usuário autenticado.

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Respostas

🟢200

*/*

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-homolog.docsend.com.br/api/v1/obrigacoes/dashboard?tenantId' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "totalObrigacoes": 0,
    "totalPendentes": 0,
    "totalEnviadas": 0,
    "totalVencidas": 0,
    "totalProximasVencimento": 0,
    "totalObrigacoesAtivas": 0,
    "totalClientesComObrigacoes": 0,
    "obrigacoesPorDepartamento": {
        "property1": 0,
        "property2": 0
    },
    "obrigacoesPorStatus": {
        "property1": 0,
        "property2": 0
    },
    "taxaCumprimento": 0
}

Modificado em 2026-02-24 18:28:37

Página anterior

Buscar aberturas de e-mail

Próxima página

Totais do período