Melhores práticas da Reports API

Esta página apresenta as melhores práticas para o uso eficaz da Reports API da Vonage.

Otimização de solicitações com filtros

Aproveite as opções de filtragem para personalizar suas solicitações. Os filtros disponíveis na Reports API dependem do produto solicitado. Veja mais detalhes na parâmetros de consulta para o método síncrono, e no corpo da solicitação para o método assíncrono.

O uso de filtros ajuda a recuperar apenas os dados necessários, otimizando as chamadas à API e reduzindo o custo das solicitações do usuário.

Os filtros mais populares são:

  • filtragem por intervalo de datas (date_start, date_end)
  • filtrando por id para obter o status atual do evento específico (mensagem/chamada, etc.) — compatível apenas com o endpoint síncrono
  • filtragem por números de telefone (to, from, etc.)

Melhores práticas para monitorar o status das mensagens

Para acompanhar o status mais recente da mensagem, você deve solicitar o relatório usando o id parâmetro de solicitação - isso está disponível para o síncrono apenas por meio desse método. É um método muito mais eficiente do que solicitar os mesmos dados várias vezes.

Otimizando as solicitações com todas as suas subcontas

Se você pretende solicitar o relatório de uma conta principal com todas as suas subcontas e o número de subcontas for superior a 10, considere o seguinte procedimento para obter seu relatório muito mais rapidamente:

  1. Ligue para o API de subcontas para obter a lista completa de todas as subcontas associadas ao ID da sua conta principal.
  2. Chame a Reports API separadamente para cada subconta e para o ID da sua conta principal, sem subcontas.

Entendendo os preços e o modelo de cobrança “Pay as You Go”

Com o Pague conforme o uso modelo de precificação, será cobrado por registro no relatório. Consulte esta página para ver exemplos. Se você solicitar o mesmo CDR em vários relatórios, será cobrado várias vezes.

Para ter uma ideia de quantos CDRs você pode obter em um determinado período, acesse Painel de controle e, em seguida, vá para o Análise no menu de navegação à esquerda. Dessa forma, será mais fácil para você estimar o preço do seu relatório.

Limitações de manuseio

  • Limite de pontos de extremidade assíncronos - Atualmente, é possível gerar um relatório arquivado com no máximo 1 GB. Isso equivale a cerca de 7 milhões de registros. Dependendo do produto, esse número pode ser maior para aqueles com menos colunas. Para reduzir o número de registros em um relatório, tente obter os dados em partes. Você pode filtrar seus dados por período, status, número de telefone etc. Verifique preços para mais detalhes.
  • Limites de taxa - Esteja ciente do limite de taxa. A Reports API suporta cinco solicitações por segundo quando usada de forma assíncrona e dez solicitações por segundo quando usada de forma síncrona. Ultrapassar esses limites resultará em um HTTP 429: Too Many Requests erro.

Escolhendo entre o método síncrono e o assíncrono

Se você quiser obter dados em pequenos blocos mais rapidamente, use o síncrono método (É possível obter um número ilimitado de registros do endpoint de sincronização em 1.000 blocos de dados).

Se você pretende trabalhar com conjuntos de dados maiores (mais de 10.000 registros), use o assíncrono método. O método síncrono é mais adequado para clientes que precisam de dados em tempo real para seus painéis ou armazenamentos internos. A vantagem do método assíncrono é que ele permite que os usuários recebam seus relatórios como arquivos CSV, que podem ser utilizados para análises manuais posteriores. Além disso, com o relatório assíncrono, os usuários podem obter dados de todas as suas subcontas em um único relatório.

Monitoramento eficaz do uso da API

Implemente um monitoramento interno para acompanhar seus padrões de uso da API ou utilize a Reports API junto com o produto REPORTS-USAGE para obter informações sobre o uso da Reports API. O serviço é gratuito, e os dados dos últimos 13 meses estão disponíveis — isso ajudará você a identificar possíveis ineficiências, otimizar sua solicitação e permanecer dentro do orçamento planejado.