Relatório de uso por grupo

Sandbox

GET

/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 Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/reports/envelopes-usage?startDate=undefined&endDate=undefined'

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-09-28 20:20:45

Página anterior

Relatório de envelopes