DOCS

Uso da API

Monitore o volume de chamadas à API da sua organização e o uso por produto, e exporte seu histórico de uso para CSV.

A página Usage no Dashboard mostra como sua organização está usando a API da Zonos ao longo do tempo. Você pode ver o volume total de chamadas, quais produtos usa mais e como o uso evolui mês a mês — e então exportar os dados subjacentes para um arquivo CSV para conciliação, revisão de cobrança ou análise mais profunda.

Para abri-la, entre em Dashboard e selecione Usage na navegação esquerda.

Lendo o painel 

No topo da página, dois cards resumem sua atividade no período selecionado:

  • Total API calls — O número total de chamadas à API no período selecionado. Ao visualizar granularidade mensal, este card também mostra a variação percentual em relação ao mês anterior.
  • Most used API — O produto Zonos que você chama com mais frequência.

Abaixo dos cards, o gráfico API volume plota suas chamadas ao longo do tempo como um gráfico de barras empilhadas, com cores por produto. O API type breakdown abaixo lista cada produto com sua contagem de chamadas e sua participação no uso total.

Use os controles acima do gráfico para ajustar a visualização:

  • Date range — Escolha 1 month, 3 months ou 6 months.
  • Granularity — Agrupe a atividade em intervalos Daily, Weekly ou Monthly.

Quais produtos de API são rastreados 

O uso é reportado por produto Zonos para que você veja exatamente para onde vão suas chamadas:

ProdutoDescrição
ClassifySolicitações de classificação de código HS
Landed CostSolicitações de cálculo de duty, impostos e taxas
Order CompletePedidos concluídos pela API da Zonos
Denied PartySolicitações de screening de partes negadas (Screen)
Restricted ItemVerificações de restrição de itens (Restrict)

Exporte seu uso para CSV 

Para baixar um CSV do seu histórico de uso:

  1. Na página Usage, clique em Export.
  2. No diálogo Download API usage CSV, escolha um Date range. Selecione um preset — This month, Last month, Last 7 days, Last 30 days, Last 90 days, This quarter, Last quarter, Year to date ou Last year — ou escolha Custom e defina sua própria Start date e End date.
  3. Em API types, selecione quais produtos incluir. Todos os produtos suportados vêm selecionados por padrão.
  4. Escolha uma GranularityDaily, Weekly ou Monthly — para controlar como as linhas são agrupadas por data.
  5. Clique em Download.

O diálogo abre pré-preenchido com o intervalo de datas e a granularidade atualmente exibidos na página, para que você possa exportar o que está vendo com um clique.

O arquivo exportado contém as seguintes colunas:

ColunaDescrição
PeriodO intervalo de datas da linha, com base na granularidade escolhida
API TypeO produto Zonos ao qual as chamadas pertencem
Call CountO número de chamadas à API daquele produto naquele período

Nota: Se nenhum uso corresponder aos filtros selecionados, nenhum arquivo é baixado e o Dashboard informa que não havia nada para exportar. Tente ampliar o intervalo de datas ou selecionar mais tipos de API.

Aviso de migração de dados de uso 

A Zonos migrou recentemente para um sistema aprimorado de rastreamento de uso da API. Dados de uso anteriores à migração podem estar incompletos ou ausentes — isso é esperado. Todo o uso a partir de agora é rastreado com precisão.

Esta página foi útil?