BAbagisto
Admin Reporting: Customers

Reporting — customers (View Details)

Changed on

The detailed table form of a customer stat (the admin "View Details" page). statistics is { columns, records }. ?type= picks the stat group.

get/reporting/customers/view

Request

Query parameters

type'total-customers' | 'customers-with-most-sales' | 'customers-with-most-orders' | 'customers-with-most-reviews' | 'top-customer-groups'

Stat group.

startstring date

Start date.

endstring date

End date.

channelstring

Channel code.

Response

AdminReportingCustomers collection

entitystring nullable
typestring nullable
statisticsobject nullable

Example response

[
  {
    "statistics": {
      "customers": {
        "previous": 1,
        "current": 9,
        "progress": 800
      },
      "over_time": {
        "previous": [
          {
            "label": "23 May",
            "total": 1
          }
        ],
        "current": [
          {
            "label": "26 May",
            "total": 9
          }
        ]
      }
    }
  }
]

Changes