SuperSign - API Oficial
  1. Auditoria e relatórios
  • SuperSign API Pública
    • Introdução
      • Crie seu primeiro envelope no Sandbox
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
      • Gerar cliente com OpenAPI
      • Evento ENVELOPE_SENT
      • Evento SIGNATORY_SIGNED
      • Evento ENVELOPE_COMPLETED
      • Evento ENVELOPE_VOIDED
      • Evento ENVELOPE_EXPIRED
      • Segurança e verificação
      • Entregas, retentativas e reenvio
      • Testar na Sandbox e automatizar
      • Conceitos da API V4
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
      • Entrega do convite pela integração
      • Evento PARTICIPANT_VIEWED
      • Guia completo da API V4
      • Assinatura embutida (sob consulta)
      • Salvar os documentos assinados no seu Drive
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Listar chamadas da própria chave
        • Consultar consumo do ciclo
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Consultar link de assinatura
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Baixar o PDF de exemplo
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Enviar um evento de teste para o webhook
        • Atualizar webhook
        • Criar webhook
        • Listar webhooks
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
        • Achar texto (âncora) no documento do modelo
      • Auditoria e relatórios
        • Relatório de consumo do plano
          GET
        • Relatório de recusas, anulações e prazos vencidos
          GET
        • Listar envelopes anulados
          GET
        • Relatório de envelopes
          GET
        • Relatório de uso por grupo
          GET
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Auditoria e relatórios

Relatório de uso por grupo

Sandbox
https://api.sandbox.supersign.com.br
Sandbox
https://api.sandbox.supersign.com.br
GET
https://api.sandbox.supersign.com.br
/v4/api/reports/envelopes-usage
Consumo de envelopes por grupo da conta (enviados, concluídos, pendentes, cancelados), com filtro por período. Sem datas, considera os últimos 30 dias. Devolve no máximo 500 grupos, sem paginação. Só para proprietário, administrador ou membro com a permissão de ver relatórios; os demais recebem 403.

Requisição

Parâmetros de Consulta

Respostas

🟢200OK
application/json
Sucesso
Headers

Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.sandbox.supersign.com.br/v4/api/reports/envelopes-usage?startDate=undefined&endDate=undefined'
Response Response Example
200 - Exemplo 1
{
    "summary": {
        "totalUsers": 0,
        "totalSent": 0,
        "totalCompleted": 0,
        "totalPending": 0,
        "totalCancelled": 0
    },
    "data": [
        {
            "groupId": "string",
            "groupName": "string",
            "usersCount": 0,
            "sentEnvelopes": 0,
            "completedEnvelopes": 0,
            "pendingEnvelopes": 0,
            "cancelledEnvelopes": 0
        }
    ]
}
Modificado em 2026-11-13 20:41:20
Página anterior
Relatório de envelopes
Próxima página
Aplicar etiqueta ao envelope
Built with