Metrics

Métricas do Magazord pela API

Seu cliente conecta a conta do Magazord e seu produto consulta 11 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": "magazord:orders",
      "component": "number_v1",
      "metrics": [
        "orders_count"
      ],
      "dimensions": [
        "user"
      ]
    }
  ]
}
Exemplo: "Pedidos" em outubro, comparado a setembro.

Mais exemplos de chamadas no Magazord

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}).

Tabela

Pedidos por data

Tabela com pedidos, situação e valores.

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": "magazord:orders_table",
      "component": "datatable_v1",
      "metrics": [
        "revenue_value",
        "shipping_value",
        "discount_value",
        "created_at"
      ],
      "dimensions": [
        "order_code",
        "status",
        "payment_method"
      ]
    }
  ]
}

Número

Receita

Receita total dos pedidos 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": "magazord:revenue",
      "component": "number_v1",
      "metrics": [
        "revenue_value"
      ],
      "dimensions": [
        "user"
      ]
    }
  ]
}

Números

8 métricas

  • Pedidos

    Número total de pedidos no período.

    magazord:orders
  • Receita

    Receita total dos pedidos no período.

    magazord:revenue
  • Ticket Médio

    Receita média por pedido.

    magazord:average_ticket
  • Frete

    Total de frete cobrado nos pedidos.

    magazord:shipping
  • Descontos

    Total de descontos aplicados nos pedidos.

    magazord:discounts
  • Taxa de cancelamento

    Percentual de pedidos cancelados sobre o total de pedidos no período.

    magazord:cancellation_rate
  • Frete médio

    Custo médio de frete por pedido no período.

    magazord:average_shipping
  • Desconto médio

    Desconto médio por pedido no período.

    magazord:average_discount

Tabelas

3 métricas

  • Pedidos por data

    Tabela com pedidos, situação e valores.

    magazord:orders_table
  • Pedidos por situação

    Distribuição de pedidos por situação no período.

    magazord:orders_by_status
  • Vendas por origem

    Pedidos, receita e ticket médio por canal de origem (Site, Marketplace, Manual).

    magazord:origin_breakdown

Veja o Connect aplicado ao seu produto.

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