Metrics

Métricas do Nuvemshop pela API

Seu cliente conecta a conta do Nuvemshop e seu produto consulta 26 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "nuvem_shop:sales",
      "component": "number_v1",
      "metrics": [
        "sales_count"
      ],
      "dimensions": [
        "orders"
      ]
    }
  ]
}
Exemplo: "Vendas" em outubro, comparado a setembro.

Mais exemplos de chamadas no Nuvemshop

O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Pedidos ao longo do tempo

Este gráfico ilustra a quantidade de vendas realizadas durante o período selecionado.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "nuvem_shop:orders_over_time",
      "component": "chart_v1",
      "metrics": [
        "sales_count"
      ],
      "dimensions": [
        "orders"
      ]
    }
  ]
}

Tabela

Quantidade de Parcelas

Esta tabela mostra o número de pedidos e a receita por número de parcelas.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "nuvem_shop:number_of_installments",
      "component": "datatable_v1",
      "metrics": [
        "sales_count",
        "revenue_value"
      ],
      "dimensions": [
        "installments"
      ]
    }
  ]
}

Número

Receita

A soma dos pagamentos feitos pelos seus clientes (não incluindo pedidos cancelados) durante o período analisado.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "nuvem_shop:revenue",
      "component": "number_v1",
      "metrics": [
        "revenue_value"
      ],
      "dimensions": [
        "orders"
      ]
    }
  ]
}

Números

13 métricas

  • Vendas

    O número total de vendas com pagamento confirmado no período selecionado.

    nuvem_shop:sales
  • Receita

    A soma dos pagamentos feitos pelos seus clientes (não incluindo pedidos cancelados) durante o período analisado.

    nuvem_shop:revenue
  • Cupons válidos

    O número de cupons ativos no período analisado.

    nuvem_shop:coupons
  • Clientes Recorrentes

    O número de clientes que já haviam feito compras anteriores e retornaram para comprar durante o período analisado.

    nuvem_shop:recurring_customers
  • Clientes Novos

    O número de clientes que fizeram sua primeira compra durante o período analisado.

    nuvem_shop:new_customers
  • Produtos Vendidos

    O número total de itens vendidos durante o período analisado.

    nuvem_shop:sold_products
  • Ticket Médio

    O ticket médio é calculado dividindo a receita total pelo número de vendas realizadas no período selecionado. Essa métrica fornece uma visão sobre o valor médio gasto por transação.

    nuvem_shop:average_ticket
  • Carrinhos convertidos em vendas

    O número de vezes que os usuários clicaram em 'Finalizar Pedido' no checkout.

    nuvem_shop:all_sales
  • Carrinhos que podem virar vendas

    O número de vezes que o checkout foi abandonado após o preenchimento do endereço de entrega e o avanço para a segunda etapa do processo de compra. Esta métrica pode retornar dados diferentes para um mesmo período, pois a Nuvemshop guarda os dados de carrinhos abandonados por até 30 dias. Após esse prazo, não é mais possível verificar os dados desses carrinhos.

    nuvem_shop:abandoned_checkouts
  • Meios de pagamento selecionados

    O número total de vezes que um método de pagamento foi selecionado na finalização da compra. Esta métrica pode retornar dados diferentes para um mesmo período, pois a Nuvemshop guarda os dados de carrinhos abandonados por até 30 dias. Após esse prazo, não é mais possível verificar os dados desses carrinhos.

    nuvem_shop:selected_payment_methods
  • Meios de envio selecionados

    O número total de vezes que um cliente selecionou um método de envio durante a finalização da compra. Esta métrica pode retornar dados diferentes para um mesmo período, pois a Nuvemshop guarda os dados de carrinhos abandonados por até 30 dias. Após esse prazo, não é mais possível verificar os dados desses carrinhos.

    nuvem_shop:selected_shipping_methods
  • Dados pessoais completos

    O número total de vezes que os usuários preencheram o campo de e-mail na finalização da compra. Esta métrica pode retornar dados diferentes para um mesmo período, pois a Nuvemshop guarda os dados de carrinhos abandonados por até 30 dias. Após esse prazo, não é mais possível verificar os dados desses carrinhos.

    nuvem_shop:personal_data_filled
  • Endereços completos

    O número total de vezes que os usuários preencheram o endereço de entrega na finalização da compra. Esta métrica pode retornar dados diferentes para um mesmo período, pois a Nuvemshop guarda os dados de carrinhos abandonados por até 30 dias. Após esse prazo, não é mais possível verificar os dados desses carrinhos.

    nuvem_shop:shipping_address_filled

Gráficos

4 métricas

  • Pedidos ao longo do tempo

    Este gráfico ilustra a quantidade de vendas realizadas durante o período selecionado.

    nuvem_shop:orders_over_time
  • Produtos vendidos ao longo do tempo

    Quantidade de itens vendidos durante o período analisado.

    nuvem_shop:products_over_time
  • Clientes ao longo do tempo

    Este gráfico exibe a evolução do número de Novos Clientes e Clientes Recorrentes durante o período selecionado. É exibido os dias que houveram clientes novos e clientes recorrentes.

    nuvem_shop:new_returning_customers_over_time
  • Receita e ticket médio ao longo do tempo

    Este gráfico mostra a evolução da Receita Total e do Ticket Médio durante o período analisado.

    nuvem_shop:revenue_averageTicket_over_time

Tabelas

9 métricas

  • Quantidade de Parcelas

    Esta tabela mostra o número de pedidos e a receita por número de parcelas.

    nuvem_shop:number_of_installments
  • Desempenho dos Cupons

    Esta tabela mostra o resumo de desempenho dos cupons.

    nuvem_shop:coupon_performance
  • Desempenho por estado

    Esta tabela mostra um resumo de desempenho por estado durante o período analisado.

    nuvem_shop:province_performance
  • Desempenho por frete

    Esta tabela mostra o valor das vendas e a receita agrupados por configuração de envio.

    nuvem_shop:shipping_performance
  • Desempenho por meios de envio

    Esta tabela mostra o desempenho dos métodos de envio durante o período analisado.

    nuvem_shop:shipping_method_performance
  • Desempenho dos métodos de pagamento

    Esta tabela mostra o desempenho de cada um dos métodos de pagamento disponíveis.

    nuvem_shop:payment_method_performance
  • Desempenho dos meios de pagamento

    Esta tabela mostra o desempenho de cada um dos sistemas de pagamento disponíveis.

    nuvem_shop:payment_system_performance
  • Desempenho dos Produtos

    Resumo do desempenho de vendas de produtos durante o período analisado.

    nuvem_shop:product_performance
  • Fontes de tráfego UTM

    Esta tabela mostra a receita e o valor das vendas, agrupados por informações sobre a origem dos visitantes que compraram em sua loja.

    nuvem_shop:traffic_source_performance

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.