Metorik Docs

Reports

Orders grouped by

Returns order metrics grouped by a chosen store dimension, so you can compare
order performance across segments like country or other supported grouping values.
Responses are capped at 1500 grouped rows.

GET /api/v1/store/reports/orders-grouped-by

Orders grouped by

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/reports/orders-grouped-by' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "meta": {
    "report_link": "https://app.metorik.com/reports/orders-grouped#orders-grouped-by"
  },
  "totals": {
    "gross": 124550.42,
    "net": 118420.13,
    "orders": 712,
    "customers": 508,
    "items": 1196,
    "aov": 174.93,
    "aoi": 1.68,
    "discounts": 2140.55,
    "refunds": 1986.23,
    "taxes": 10334.89,
    "shipping": 5421.1,
    "fees": 882.41
  },
  "data": [
    {
      "date": "United States",
      "orders": 392,
      "customers": 281,
      "gross": 68210.18,
      "net": 64985.8,
      "items": 670,
      "aov": 174.01,
      "aoi": 1.71,
      "discounts": 1220.4,
      "refunds": 880.2,
      "taxes": 5642.81,
      "shipping": 3014.2,
      "fees": 481.77
    }
  ]
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

  • custom_field_key string

    Required when grouped_by is custom_field. Custom field key to group orders by. Example: sales_channel

  • end_date string required

    End date in the store timezone using YYYY-MM-DD format. Example: 2026-02-28

  • grouped_by string enum required

    Dimension to group orders by. Example: billing_address_country

  • order_filters string

    Optional JSON-encoded array of order-level filters applied before calculating the report. See Order Filters Reference. Cannot be combined with segment. Example: [{"field":"billing_address_country","operator":"eq","value":"US"}]

  • segment integer

    Optional saved store-wide order segment ID. You can find the ID on the order segments page. Example: 123

  • start_date string required

    Start date in the store timezone using YYYY-MM-DD format. Example: 2026-02-01

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • meta object
    + Show Child Attributes
    • report_link string
  • totals object
    + Show Child Attributes
    • gross number
    • net number
    • orders integer
    • customers integer
    • items integer
    • aov number
    • aoi number
    • discounts number
    • refunds number
    • taxes number
    • shipping number
    • fees number
  • data[] object array
    + Show Child Attributes
    • date string
    • orders integer
    • customers integer
    • gross number
    • net number
    • items integer
    • aov number
    • aoi number
    • discounts number
    • refunds number
    • taxes number
    • shipping number
    • fees number