Abrir a guia Relatórios.
Última atualização em
11 de mai de 2026
Gere relatórios CSV programados para rastrear o uso de SMS e WhatsApp, monitorar cotas e analisar o consumo por grupo.
As exportações de uso de transação oferecem visibilidade da atividade de SMS e WhatsApp em toda a conta, incluindo quantidades compradas, totais de consumo e uso por grupo. Essas exportações incluem:
- Autenticação por SMS
- Entrega de SMS
- Autenticação por WhatsApp
- Transações de entrega do WhatsApp.
As exportações são geradas como instantâneos programados, não consultas em tempo real. Use cronogramas para monitoramento contínuo ou prepare manualmente a exportação para regenerá-la quando precisar de dados atualizados imediatamente.
Como funcionam as exportações de dados
Os dados de transação são exportados como arquivos CSV dentro de um intervalo de datas definido e com filtros especificados.
- As exportações são geradas de forma assíncrona e não são em tempo real.
- As exportações são atualizadas em um cronograma configurado.
- Selecionar Preparar regenera a exportação com os dados mais recentes disponíveis.
Cada linha no CSV representa um único contrato e inclui dados de uso de transação de SMS e WhatsApp.
Criar um relatório de uso de transação
Criar um relatório CSV a partir da guia Relatórios.
-
-
Selecione Nova exportação.
-
Selecione Consumo de transações.
-
Definir a exportação:
- Selecione um intervalo de datas.
- Aplicar filtros, incluindo um ou mais Grupos se necessário.
-
Selecionar Selecionar colunas e escolher os dados a incluir.
Para uso de transação de SMS e WhatsApp, expanda Complemento na seção Colunas disponíveis e inclua o seguinte:
- Quantidade adquirida do complemento de entrega de mensagens — Número total de transações adquiridas.
- Data inicial para complemento de entrega de mensagem — A data efetiva anual quando a cota de transação foi aplicada.
- Contagem de consumo de OTP por SMS — Transações usadas para autenticação baseada em SMS.
- Contagem de consumo de entrega de contratos por SMS — Transações usadas para entregar links de contratos via SMS.
- Contagem de consumo de WhatsApp OTP — Transações usadas para autenticação baseada em WhatsApp.
- Contagem de consumo de entrega de contratos pelo WhatsApp — Transações usadas para entregar links de contratos via WhatsApp.
Para habilitar relatórios no nível do grupo, inclua também a coluna Grupo do Remetente.
-
Selecione Salvar e forneça um nome para a exportação.
A exportação é gerada de forma assíncrona e aparece na lista Relatórios Recentes quando concluída.
Configurar dados precisos no nível do grupo
O uso no nível do grupo requer filtragem e seleção de colunas.
- Aplique um ou mais filtros de grupo ao definir a exportação.
- Inclua a coluna Grupo de remetentes na exportação.
Se algum dos requisitos não for atendido, o uso no nível do grupo não será representado com precisão nos dados exportados.
Garantir dados precisos de uso do contrato
Para gerar relatórios referentes ao período correto do contrato:
- Use a data de início efetivo da cota do telefone como data inicial do relatório.
- Este valor está disponível em: Configurações da conta > Configurações de envio
Usar a data inicial correta garante que todas as transações do contrato atual sejam incluídas e que os totais de uso e resumos no nível do grupo sejam precisos.
Agendar um relatório
Agende um relatório para gerar dados de transação atualizados automaticamente.
-
Crie uma nova exportação ou edite uma existente.
-
Selecione as reticências da exportação que deseja agendar e escolha Agendar no menu suspenso.
-
Configure o cronograma definindo o:
- Frequência do cronograma (diário, semanal, mensal)
- Para quais emails enviar o relatório
- Uma mensagem opcional
-
Salve a programação.
Os relatórios agendados são gerados automaticamente e podem ser baixados da lista Relatórios Recentes ou entregues por email.
Atualizar uma exportação com os dados mais recentes
Para atualizar uma exportação:
- Selecione Preparar para regenerar a exportação imediatamente.
- Ou aguarde a próxima execução programada.
- Você também pode criar uma nova exportação com os mesmos parâmetros, se necessário.
Baixar uma exportação usando a API
Recupere a exportação gerada mais recente usando a API.
- Endpoint: POST /api/rest/v6/reportDownload
- Parâmetro obrigatório: scheduleId
Este ponto de acesso:
- Requer um cronograma de exportação criado na interface de Relatórios.
- Retorna a URL de download apenas para o arquivo CSV mais recente.
- Não gera uma nova exportação por demanda.
Se a exportação não foi atualizada, o arquivo CSV gerado anteriormente é retornado.
Ao baixar arquivos CSV grandes, o processamento pode demorar mais porque todos os registros devem ser preparados. Configure um tempo-limite de cliente de pelo menos 5 minutos para garantir downloads bem-sucedidos.
Disponibilidade e retenção de exportações
- Arquivos CSV exportados são armazenados por 7 dias.
- Após 7 dias, o arquivo expira e não fica mais disponível para download.
- Para acessar dados atualizados, regenere a exportação usando Preparar ou aguarde a próxima execução programada.
Informações importantes
- As exportações devem ser criadas ou programadas antes de poderem ser acessadas pela API.
- Apenas o arquivo CSV mais recente de um cronograma fica disponível pela API.
- Relatórios em nível de grupo requerem ambos:
- Um filtro de grupo
- A coluna Grupo do remetente
- Usar a data de início efetivo da cota de telefone correta é necessário para relatórios precisos em nível de contrato.
- Arquivos de exportação expiram após sete dias e devem ser regenerados, se necessário.
