---
title: "Pages customers' activity 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}/customer_activity`

## Authentication

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

## Path parameters

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

## Query parameters

- `from` (`listCustomerActivity.query.from`; string, optional)
  - format `date`; pattern `^\d{4}-\d{2}-\d{2}$`
- `to` (`listCustomerActivity.query.to`; string, optional)
  - format `date`; pattern `^\d{4}-\d{2}-\d{2}$`
- `filter` (`listCustomerActivity.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listCustomerActivity.query.sort`; string, optional) — Sorted by name, rows without a value come last either way.
  - one of `"gross"`, `"orders"`, `"recent"`, `"name"`
- `direction` (`listCustomerActivity.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listCustomerActivity.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listCustomerActivity.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listCustomerActivity.query.count`; boolean, optional)

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/customer_activity';
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>/customer_activity"

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

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

print(response.text)
```

## Responses

### 200

Pages customers' activity over a period.

#### Example

```json
{
  "items": [
    {
      "id": "string",
      "customer": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "erased": true
      },
      "country": "string",
      "currency": "string",
      "exponent": 0,
      "orders": 0,
      "gross": 0,
      "average": 0,
      "first_order_at": "string",
      "last_order_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "time_zone": "string",
  "from": "string",
  "to": "string"
}
```

- `items` (`listCustomerActivity.response.200.items`; array<object>, required)
  - `id` (`listCustomerActivity.response.200.items.id`; string, required)
  - `customer` (`listCustomerActivity.response.200.items.customer`; any of, required)
    - any of: `object`, `null`
  - `country` (`listCustomerActivity.response.200.items.country`; any of, required)
    - any of: `string`, `null`
  - `currency` (`listCustomerActivity.response.200.items.currency`; string, required)
  - `exponent` (`listCustomerActivity.response.200.items.exponent`; any of, required)
    - any of: `number`, `null`
  - `orders` (`listCustomerActivity.response.200.items.orders`; number, required)
  - `gross` (`listCustomerActivity.response.200.items.gross`; any of, required)
    - any of: `number`, `null`
  - `average` (`listCustomerActivity.response.200.items.average`; any of, required)
    - any of: `number`, `null`
  - `first_order_at` (`listCustomerActivity.response.200.items.first_order_at`; string, required)
  - `last_order_at` (`listCustomerActivity.response.200.items.last_order_at`; string, required)
- `cursor` (`listCustomerActivity.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `time_zone` (`listCustomerActivity.response.200.time_zone`; string, required)
- `from` (`listCustomerActivity.response.200.from`; string, required)
- `to` (`listCustomerActivity.response.200.to`; string, required)
- `total` (`listCustomerActivity.response.200.total`; number, optional)
- `facets` (`listCustomerActivity.response.200.facets`; map<map<number>>, optional)

### 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` (`listCustomerActivity.response.default.type`; string, required)
  - format `uri`
- `title` (`listCustomerActivity.response.default.title`; string, required)
- `status` (`listCustomerActivity.response.default.status`; integer, required)
- `detail` (`listCustomerActivity.response.default.detail`; string, required)
- `code` (`listCustomerActivity.response.default.code`; string, optional)
- `context` (`listCustomerActivity.response.default.context`; object, optional)
- `reached_core` (`listCustomerActivity.response.default.reached_core`; boolean, optional)
- `core_answer` (`listCustomerActivity.response.default.core_answer`; string, optional)


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