Metrics

Magazord metrics via API

Your customer connects their Magazord account and your product queries 11 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

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"
      ]
    }
  ]
}
Example: "Orders" in October, compared to September.

More Magazord request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Table

Orders by date

Table with orders, status, and values.

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"
      ]
    }
  ]
}

Number

Revenue

Total revenue from orders for the period.

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"
      ]
    }
  ]
}

Numbers

8 metrics

  • Orders

    Total number of orders for the period.

    magazord:orders
  • Revenue

    Total revenue from orders for the period.

    magazord:revenue
  • Average ticket

    Average revenue per order.

    magazord:average_ticket
  • Shipping

    Total shipping charged on orders.

    magazord:shipping
  • Discounts

    Total discounts applied to orders.

    magazord:discounts
  • Cancellation rate

    Percentage of cancelled orders over total orders for the period.

    magazord:cancellation_rate
  • Average shipping

    Average shipping cost per order for the period.

    magazord:average_shipping
  • Average discount

    Average discount per order for the period.

    magazord:average_discount

Tables

3 metrics

  • Orders by date

    Table with orders, status, and values.

    magazord:orders_table
  • Orders by status

    Distribution of orders by status for the period.

    magazord:orders_by_status
  • Sales by origin

    Orders, revenue, and average ticket by origin channel (Site, Marketplace, Manual).

    magazord:origin_breakdown

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.