---
title: "Reads the store's customer stats over a period."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › customer

`GET /v1/stores/{store}/customers/stats`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `customer:read`

## Path parameters

- `store` (`customerStats.path.store`; string, required) — The store's id.

## Query parameters

- `from` (`customerStats.query.from`; string, optional)
  - format `date`
- `to` (`customerStats.query.to`; string, optional)
  - format `date`
- `bucket` (`customerStats.query.bucket`; string, optional)
  - one of `"day"`, `"week"`, `"month"`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/customers/stats' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/customers/stats';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/customers/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads the store's customer stats over a period.

#### Example

```json
{
  "customers": {
    "total": 0,
    "erased": 0
  },
  "new_customers": {
    "current": 0,
    "previous": 0
  },
  "returning": {
    "current": {
      "customers": 0,
      "ordered": 0
    },
    "previous": {
      "customers": 0,
      "ordered": 0
    }
  },
  "spent": [
    {
      "currency": "string",
      "exponent": 0,
      "amount": {
        "current": 0,
        "previous": 0
      },
      "gross": {
        "current": 0,
        "previous": 0
      },
      "refunded": {
        "current": 0,
        "previous": 0
      }
    }
  ],
  "all_time": {
    "orders": 0,
    "returning": 0,
    "spent": [
      {
        "currency": "string",
        "exponent": 0,
        "orders": 0,
        "amount": 0,
        "gross": 0,
        "refunded": 0,
        "average": 0
      }
    ]
  },
  "by_country": [
    {
      "orders": 0,
      "currencies": [
        {
          "currency": "string",
          "exponent": 0,
          "orders": 0,
          "sales": 0,
          "average": 0
        }
      ],
      "country": "string",
      "customers": 0
    }
  ],
  "series": [
    {
      "start": "string",
      "end": "string",
      "customers": 0,
      "previous_customers": 0
    }
  ],
  "bucket": "string",
  "time_zone": "string",
  "from": "string",
  "to": "string",
  "previous_range": {
    "from": "string",
    "to": "string"
  }
}
```

- `customers` (`customerStats.response.200.customers`; object, required)
  - `total` (`customerStats.response.200.customers.total`; number, required)
  - `erased` (`customerStats.response.200.customers.erased`; number, required)
- `new_customers` (`customerStats.response.200.new_customers`; object, required)
  - `current` (`customerStats.response.200.new_customers.current`; number, required)
  - `previous` (`customerStats.response.200.new_customers.previous`; number, required)
- `returning` (`customerStats.response.200.returning`; object, required)
  - `current` (`customerStats.response.200.returning.current`; object, required)
    - `customers` (`customerStats.response.200.returning.current.customers`; number, required)
    - `ordered` (`customerStats.response.200.returning.current.ordered`; number, required)
  - `previous` (`customerStats.response.200.returning.previous`; object, required)
    - `customers` (`customerStats.response.200.returning.previous.customers`; number, required)
    - `ordered` (`customerStats.response.200.returning.previous.ordered`; number, required)
- `spent` (`customerStats.response.200.spent`; array<object>, required)
  - `currency` (`customerStats.response.200.spent.currency`; string, required)
  - `exponent` (`customerStats.response.200.spent.exponent`; any of, required)
    - any of: `number`, `null`
  - `amount` (`customerStats.response.200.spent.amount`; any of, required)
    - any of: `object`, `null`
  - `gross` (`customerStats.response.200.spent.gross`; any of, required)
    - any of: `object`, `null`
  - `refunded` (`customerStats.response.200.spent.refunded`; any of, required)
    - any of: `object`, `null`
- `all_time` (`customerStats.response.200.all_time`; object, required)
  - `orders` (`customerStats.response.200.all_time.orders`; number, required)
  - `returning` (`customerStats.response.200.all_time.returning`; number, required)
  - `spent` (`customerStats.response.200.all_time.spent`; array<object>, required)
    - `currency` (`customerStats.response.200.all_time.spent.currency`; string, required)
    - `exponent` (`customerStats.response.200.all_time.spent.exponent`; any of, required)
      - any of: `number`, `null`
    - `orders` (`customerStats.response.200.all_time.spent.orders`; number, required)
    - `amount` (`customerStats.response.200.all_time.spent.amount`; any of, required)
      - any of: `number`, `null`
    - `gross` (`customerStats.response.200.all_time.spent.gross`; any of, required)
      - any of: `number`, `null`
    - `refunded` (`customerStats.response.200.all_time.spent.refunded`; any of, required)
      - any of: `number`, `null`
    - `average` (`customerStats.response.200.all_time.spent.average`; any of, required)
      - any of: `number`, `null`
- `by_country` (`customerStats.response.200.by_country`; array<object>, required)
  - `orders` (`customerStats.response.200.by_country.orders`; number, required)
  - `currencies` (`customerStats.response.200.by_country.currencies`; array<object>, required)
    - `currency` (`customerStats.response.200.by_country.currencies.currency`; string, required)
    - `exponent` (`customerStats.response.200.by_country.currencies.exponent`; any of, required)
      - any of: `number`, `null`
    - `orders` (`customerStats.response.200.by_country.currencies.orders`; number, required)
    - `sales` (`customerStats.response.200.by_country.currencies.sales`; any of, required)
      - any of: `number`, `null`
    - `average` (`customerStats.response.200.by_country.currencies.average`; any of, required)
      - any of: `number`, `null`
  - `country` (`customerStats.response.200.by_country.country`; any of, required)
    - any of: `string`, `null`
  - `customers` (`customerStats.response.200.by_country.customers`; number, required)
- `series` (`customerStats.response.200.series`; array<object>, required)
  - `start` (`customerStats.response.200.series.start`; string, required)
  - `end` (`customerStats.response.200.series.end`; string, required)
  - `customers` (`customerStats.response.200.series.customers`; number, required)
  - `previous_customers` (`customerStats.response.200.series.previous_customers`; number, required)
- `bucket` (`customerStats.response.200.bucket`; string, required)
- `time_zone` (`customerStats.response.200.time_zone`; string, required)
- `from` (`customerStats.response.200.from`; string, required)
- `to` (`customerStats.response.200.to`; string, required)
- `previous_range` (`customerStats.response.200.previous_range`; object, required)
  - `from` (`customerStats.response.200.previous_range.from`; string, required)
  - `to` (`customerStats.response.200.previous_range.to`; string, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`customerStats.response.default.type`; string, required)
  - format `uri`
- `title` (`customerStats.response.default.title`; string, required)
- `status` (`customerStats.response.default.status`; integer, required)
- `detail` (`customerStats.response.default.detail`; string, required)
- `code` (`customerStats.response.default.code`; string, optional)
- `context` (`customerStats.response.default.context`; object, optional)
- `reached_core` (`customerStats.response.default.reached_core`; boolean, optional)
- `core_answer` (`customerStats.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/customer-stats/index.md
