Metorik Docs

Reports

Carts grouped by

Returns cart counts grouped by a selected cart field, including abandoned,
placed, and recovered counts and rates. Responses are capped at 1500 grouped rows.
Your store must already have cart tracking/data set up in Metorik for this
report to return meaningful cart activity.

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

Carts grouped by

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/reports/carts-grouped-by' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "meta": {
    "report_link": "https://app.metorik.com/reports/carts",
    "results_limited": false
  },
  "data": [
    {
      "grouped_by": "US",
      "started_count": 4,
      "abandoned_count": 1,
      "placed_count": 1,
      "recovered_count": 1,
      "placed_rate": 25,
      "abandoned_rate": 25,
      "recovered_rate": 25
    },
    {
      "grouped_by": "AU",
      "started_count": 1,
      "abandoned_count": 0,
      "placed_count": 0,
      "recovered_count": 0,
      "placed_rate": 0,
      "abandoned_rate": 0,
      "recovered_rate": 0
    }
  ]
}

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

  • 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 carts by. Example: billing_address_country

  • 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
    • results_limited boolean
  • data[] object array
    + Show Child Attributes
    • grouped_by string
    • started_count integer
    • abandoned_count integer
    • placed_count integer
    • recovered_count integer
    • placed_rate integer
    • abandoned_rate integer
    • recovered_rate integer