Metrics

Métricas do Goomer pela API

Seu cliente conecta a conta do Goomer e seu produto consulta 16 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": "goomer:total_orders",
      "component": "number_v1",
      "metrics": [
        "total_orders"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}
Exemplo: "Total de Pedidos" em outubro, comparado a setembro.

Mais exemplos de chamadas no Goomer

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 por Dia

Evolução diária dos pedidos concluídos.

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": "goomer:orders_over_time",
      "component": "chart_v1",
      "metrics": [
        "total_orders"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tabela

Detalhamento de Pagamentos

Contagem de pedidos e receita agrupados por método de pagamento.

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": "goomer:payments_breakdown",
      "component": "datatable_v1",
      "metrics": [
        "total_orders",
        "total_revenue"
      ],
      "dimensions": [
        "payment_method"
      ]
    }
  ]
}

Número

Receita total

Soma do valor dos pedidos concluídos no período.

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": "goomer:total_revenue",
      "component": "number_v1",
      "metrics": [
        "total_revenue"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}

Números

5 métricas

  • Total de Pedidos

    Número de pedidos concluídos no período (exclui cancelados).

    goomer:total_orders
  • Receita total

    Soma do valor dos pedidos concluídos no período.

    goomer:total_revenue
  • Ticket Médio

    Receita total dividida pelo número de pedidos concluídos.

    goomer:average_ticket
  • Pedidos Cancelados

    Número de pedidos cancelados no período.

    goomer:cancelled_orders
  • Taxa de Cancelamento

    Porcentagem de pedidos cancelados em relação ao total de pedidos no período.

    goomer:cancellation_rate

Gráficos

9 métricas

  • Pedidos por Dia

    Evolução diária dos pedidos concluídos.

    goomer:orders_over_time
  • Receita por Dia

    Evolução diária da receita total.

    goomer:revenue_over_time
  • Ticket Médio por Dia

    Evolução diária do ticket médio.

    goomer:avg_ticket_over_time
  • Pedidos Cancelados por Dia

    Evolução diária dos pedidos cancelados.

    goomer:cancelled_over_time
  • Pedidos por Tipo

    Distribuição dos pedidos concluídos entre delivery e consumo no local.

    goomer:orders_by_type
  • Delivery vs Consumo Local

    Participação dos pedidos concluídos por tipo de pedido.

    goomer:delivery_vs_indoor
  • Horários de Maior Venda

    Distribuição dos pedidos concluídos por faixas de horário.

    goomer:best_hours
  • Melhores Dias de Venda

    Distribuição dos pedidos concluídos por dia da semana.

    goomer:best_days
  • Métodos de Pagamento Mais Utilizados

    Número de pedidos concluídos por método de pagamento.

    goomer:payment_methods

Tabelas

2 métricas

  • Detalhamento de Pagamentos

    Contagem de pedidos e receita agrupados por método de pagamento.

    goomer:payments_breakdown
  • Itens Mais Vendidos

    Itens mais vendidos por quantidade e receita em pedidos concluídos.

    goomer:top_items

Veja o Connect aplicado ao seu produto.

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