VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Análises e relatórios

Vendas, clientes, lucro, canais de aquisição, coortes, comparação com o mercado e busca: os relatórios de análise da loja.

Esta seção reúne as rotas de análise da loja, as mesmas que alimentam as telas de relatórios do painel de administração. Elas respondem perguntas como quanto a loja vendeu, quem compra, quando compra, de onde vêm os clientes e quanto sobra de lucro. Todas são de leitura, exceto a gravação de custos de mídia, a adesão à comparação com o mercado, a carga do histórico de lucro e a criação de audiências.

Pontos-chave
  • Exigem o privilégio view_reports e o módulo analytics ligado; algumas escritas exigem também manage_settings ou o módulo crm.
  • Dinheiro é sempre inteiro em centavos; porcentagens saem em pontos-base (10000 = 100%), exceto onde o campo diz _pct.
  • Só contam como venda os pedidos que não foram cancelados, reembolsados, falhos, com chargeback ou anulados, e só os pedidos "pai".
  • Dias e horas seguem o fuso da loja (America/Sao_Paulo).
  • Há três formatos de período: start/end (obrigatórios, até 1 ano), from/to ou period (até 2 anos) e period simples.

Como funciona

Nenhuma rota guarda estado de relatório: cada chamada recalcula a partir dos pedidos. O fluxo típico de um painel é:

  1. Mostrar a visão geral

    Chame Resumo de vendas para os cartões de topo e Pedidos por status para o funil.

  2. Desenhar as séries

    Use Relatório de vendas para o gráfico por dia e Padrões de tempo para dia da semana e hora.

  3. Entender quem compra

    Clientes, métricas de clientes e coortes.

  4. Medir o retorno

    Lance os custos de mídia em Canais e acompanhe o lucro real.

As três famílias de períodos:

RotasParâmetros de períodoPadrão
report, daily, daily-revenue, top-products, revenue-by-*, customer-statsstart e end, obrigatóriosnenhum (400 se faltar)
stats, overviewperiod: today, 7days, 30days, 90days, all30days
repurchase, ltv, time-between, rfm, sales-by-day, heatmap, top-customers, sales-by-customerfrom/to ou period (inclui this_month, last_month, this_year)30days

profit, channels, campaigns e search usam from/to com padrão de 30 dias.

Conceitos-chave

Pedido pai e sub-pedido

Uma compra com produtos de vários sellers (lojistas) vira um pedido pai e um sub-pedido por seller. Os relatórios da loja olham o pedido pai, para não contar a mesma compra duas vezes. A receita por seller usa os sub-pedidos.

Centavos e pontos-base

4990 é R$ 49,90. Taxas e participações vêm em pontos-base, a centésima parte de um ponto percentual: 2500 é 25,00%. Veja Ids, dinheiro e datas.

Letra de status

O status do pedido é uma letra definida por loja. Os relatórios resolvem a letra para code, name e type pelo cadastro de status da loja; agrupe por type.

Quem pode ver

São rotas do administrador da loja. O seller (lojista) tem as próprias rotas de análise, fora desta seção. Sem o privilégio view_reports a resposta é 403 insufficient privileges; com o módulo analytics desligado, 403 module_disabled.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/admin/analytics/statsEstatísticas de pedidos de um períodoadmin
GET/api/v1/admin/analytics/overviewEstatísticas mais pedidos por statusadmin
GET/api/v1/admin/analytics/orders-by-statusContagem de pedidos por statusadmin
GET/api/v1/admin/analytics/ordersApelido de pedidos por statusadmin
GET/api/v1/admin/analytics/reportRelatório de vendas entre duas datasadmin
GET/api/v1/admin/analytics/dailyVendas por dia (só dias com pedido)admin
GET/api/v1/admin/analytics/daily-revenueReceita por dia (todos os dias do intervalo)admin
GET/api/v1/admin/analytics/revenue-by-vendorReceita por selleradmin
GET/api/v1/admin/analytics/revenue-by-categoryReceita por categoriaadmin
GET/api/v1/admin/analytics/top-productsProdutos mais vendidos entre duas datasadmin
GET/api/v1/admin/analytics/productsAtalho de produtos mais vendidos (padrão 30 dias)admin
GET/api/v1/admin/analytics/customer-statsClientes novos e recorrentesadmin
GET/api/v1/admin/analytics/top-customersRanking dos clientes que mais gastaramadmin
GET/api/v1/admin/analytics/sales-by-customerReceita por cliente em fatiasadmin
GET/api/v1/admin/analytics/repurchaseClientes novos e recorrentes na janelaadmin
GET/api/v1/admin/analytics/ltvValor de vida médio dos clientes ativosadmin
GET/api/v1/admin/analytics/time-betweenTempo médio entre pedidos do mesmo clienteadmin
GET/api/v1/admin/analytics/rfmSegmentação RFM dos clientesadmin
GET/api/v1/admin/analytics/sales-by-dayVendas por dia da semanaadmin
GET/api/v1/admin/analytics/monthly-growthPedidos e receita por mêsadmin
GET/api/v1/admin/analytics/heatmapMapa de calor de vendas por dia e horaadmin
GET/api/v1/admin/analytics/cohortsMatriz de retenção por coorteadmin
POST/api/v1/admin/analytics/cohorts/segmentCriar audiência de CRM a partir de uma célulaadmin
GET/api/v1/admin/analytics/profitRelatório de lucroadmin
GET/api/v1/admin/analytics/profit/export.csvExportar o lucro em CSVadmin
POST/api/v1/admin/analytics/profit/backfillCalcular o lucro de pedidos antigos, em lotesadmin
GET/api/v1/admin/analytics/channelsReceita e ROAS por canaladmin
GET/api/v1/admin/analytics/channels/campaignsCampanhas de um canaladmin
GET/api/v1/admin/analytics/channel-costsCustos de mídia de um mêsadmin
PUT/api/v1/admin/analytics/channel-costsGravar custos de mídiaadmin
GET/api/v1/admin/analytics/benchmarksLer a comparação com o mercadoadmin
PUT/api/v1/admin/analytics/benchmarks/settingsAderir ou sair da comparaçãoadmin
GET/api/v1/admin/analytics/searchRelatório da busca internaadmin

Erros comuns

  • Esquecer start e end nas rotas que os exigem: a resposta é 400, não um padrão de 30 dias.
  • Pedir mais de 1 ano com start/end sem period=all.
  • Somar pending_orders + completed_orders + cancelled_orders esperando chegar a total_orders: o total ignora cancelados.
  • Tratar a letra do status como universal; ela muda por loja.
  • Mandar limit acima de 100 em top-products esperando 100: volta 10.
  • Dividir centavos por 100 duas vezes ou exibir pontos-base como se fossem porcentagem.
  • Gravar custos de mídia com o rótulo do painel em vez da chave do canal.
  • Chamar o lucro sem ter preço de custo nos produtos: cogs_missing_pct alto significa lucro inflado.

Próximos passos

Resumo de vendas
Os números de topo de uma tela inicial.
Lucro real
Receita menos todos os custos.
Canais de aquisição
Receita por origem e ROAS.
Tokens
Como autenticar as chamadas.
Anterior
Executar e consultar histórico
Próxima
Resumo de vendas
Nesta página
  • Como funciona
  • Conceitos-chave
  • Pedido pai e sub-pedido
  • Centavos e pontos-base
  • Letra de status
  • Quem pode ver
  • Endpoints
  • Erros comuns
  • Próximos passos