---
title: "Reporting — customers"
method: GET
path: "/reporting/customers"
tags: ["Admin Reporting: Customers"]
---

# Reporting — customers

`GET /reporting/customers`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/reporting/customers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/reporting/customers/get.ts> (a function with typed inputs; its response is checked against the schema)

Customer reporting stats. `?type=` picks the stat group.

## Query parameters

- `type` 'total-customers' | 'customers-with-most-sales' | 'customers-with-most-orders' | 'customers-with-most-reviews' | 'top-customer-groups'
- `start` string, date
- `end` string, date
- `channel` string

## Response `200`

AdminReportingCustomers collection

- AdminReportingCustomers[]
  - `entity` string, nullable
  - `type` string, nullable
  - `dateRange` unknown[], nullable
    - unknown
  - `statistics` object, nullable

## Changes

- **2026-10-28** `982b36ea11ab`: 1 breaking
  - removed the enum value `customers-traffic` from the `query` request parameter `type`

[Operation history](https://skmtc.dev/bagisto/apis/bagisto-admin-api/changes/reporting/customers/get.md)

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)