Metrics

Goomer metrics via API

Your customer connects their Goomer account and your product queries 16 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": "goomer:total_orders",
      "component": "number_v1",
      "metrics": [
        "total_orders"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}
Example: "Total Orders" in October, compared to September.

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

Chart

Orders per Day

Daily evolution of completed orders.

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

Table

Payments Breakdown

Orders count and revenue grouped by payment method.

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

Number

Total Revenue

Sum of the order amount for completed orders in 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": "goomer:total_revenue",
      "component": "number_v1",
      "metrics": [
        "total_revenue"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}

Numbers

5 metrics

  • Total Orders

    Number of completed orders in the period (excludes cancelled orders).

    goomer:total_orders
  • Total Revenue

    Sum of the order amount for completed orders in the period.

    goomer:total_revenue
  • Average Ticket

    Total revenue divided by the number of completed orders.

    goomer:average_ticket
  • Cancelled Orders

    Number of orders cancelled in the period.

    goomer:cancelled_orders
  • Cancellation Rate

    Percentage of cancelled orders relative to total orders in the period.

    goomer:cancellation_rate

Charts

9 metrics

  • Orders per Day

    Daily evolution of completed orders.

    goomer:orders_over_time
  • Revenue per Day

    Daily evolution of total revenue.

    goomer:revenue_over_time
  • Average Ticket per Day

    Daily evolution of the average ticket.

    goomer:avg_ticket_over_time
  • Cancelled Orders per Day

    Daily evolution of cancelled orders.

    goomer:cancelled_over_time
  • Orders by Type

    Distribution of completed orders between delivery and indoor.

    goomer:orders_by_type
  • Delivery vs Indoor

    Share of completed orders by order type.

    goomer:delivery_vs_indoor
  • Top Selling Hours

    Distribution of completed orders by time ranges.

    goomer:best_hours
  • Top Selling Days

    Distribution of completed orders by weekday.

    goomer:best_days
  • Most Used Payment Methods

    Number of completed orders per payment method.

    goomer:payment_methods

Tables

2 metrics

  • Payments Breakdown

    Orders count and revenue grouped by payment method.

    goomer:payments_breakdown
  • Top Selling Items

    Most sold items by quantity and revenue in completed orders.

    goomer:top_items

See Connect applied to your product.

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