---
title: "Reads the store's takings and audience 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 › transaction

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

## Authentication

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

## Path parameters

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

## Query parameters

- `from` (`storeStats.query.from`; string, optional)
  - format `date`
- `to` (`storeStats.query.to`; string, optional)
  - format `date`
- `bucket` (`storeStats.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>/stats' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Reads the store's takings and audience stats over a period.

#### Example

```json
{
  "store_currency": {
    "currency": "string",
    "exponent": 0
  },
  "orders": {
    "current": 0,
    "previous": 0
  },
  "new_customers": {
    "current": 0,
    "previous": 0
  },
  "active_subscriptions": {
    "current": 0,
    "previous": 0
  },
  "currencies": [
    {
      "net": {
        "current": 0,
        "previous": 0
      },
      "orders": {
        "current": 0,
        "previous": 0
      },
      "series": [
        {
          "start": "string",
          "end": "string",
          "gross": 0,
          "orders": 0,
          "refunded": 0,
          "platform_fee": 0,
          "processor_fee": 0,
          "affiliate_fee": 0,
          "net": 0,
          "previous_gross": 0,
          "previous_orders": 0,
          "previous_refunded": 0,
          "previous_platform_fee": 0,
          "previous_processor_fee": 0,
          "previous_affiliate_fee": 0,
          "previous_net": 0
        }
      ],
      "platform_fee": {
        "current": 0,
        "previous": 0
      },
      "processor_fee": {
        "current": 0,
        "previous": 0
      },
      "affiliate_fee": {
        "current": 0,
        "previous": 0
      },
      "currency": "string",
      "exponent": 0,
      "gross": {
        "current": 0,
        "previous": 0
      },
      "refunded": {
        "current": 0,
        "previous": 0
      }
    }
  ],
  "bucket": "string",
  "time_zone": "string",
  "from": "string",
  "to": "string",
  "previous_range": {
    "from": "string",
    "to": "string"
  }
}
```

- `store_currency` (`storeStats.response.200.store_currency`; any of, required)
  - any of: `object`, `null`
- `orders` (`storeStats.response.200.orders`; object, required)
  - `current` (`storeStats.response.200.orders.current`; number, required)
  - `previous` (`storeStats.response.200.orders.previous`; number, required)
- `new_customers` (`storeStats.response.200.new_customers`; object, required)
  - `current` (`storeStats.response.200.new_customers.current`; number, required)
  - `previous` (`storeStats.response.200.new_customers.previous`; number, required)
- `active_subscriptions` (`storeStats.response.200.active_subscriptions`; object, required)
  - `current` (`storeStats.response.200.active_subscriptions.current`; number, required)
  - `previous` (`storeStats.response.200.active_subscriptions.previous`; number, required)
- `currencies` (`storeStats.response.200.currencies`; array<object>, required)
  - `net` (`storeStats.response.200.currencies.net`; any of, required)
    - any of: `object`, `null`
  - `orders` (`storeStats.response.200.currencies.orders`; object, required)
    - `current` (`storeStats.response.200.currencies.orders.current`; number, required)
    - `previous` (`storeStats.response.200.currencies.orders.previous`; number, required)
  - `series` (`storeStats.response.200.currencies.series`; array<object>, required)
    - `start` (`storeStats.response.200.currencies.series.start`; string, required)
    - `end` (`storeStats.response.200.currencies.series.end`; string, required)
    - `gross` (`storeStats.response.200.currencies.series.gross`; any of, required)
      - any of: `number`, `null`
    - `orders` (`storeStats.response.200.currencies.series.orders`; number, required)
    - `refunded` (`storeStats.response.200.currencies.series.refunded`; any of, required)
      - any of: `number`, `null`
    - `platform_fee` (`storeStats.response.200.currencies.series.platform_fee`; any of, required)
      - any of: `number`, `null`
    - `processor_fee` (`storeStats.response.200.currencies.series.processor_fee`; any of, required)
      - any of: `number`, `null`
    - `affiliate_fee` (`storeStats.response.200.currencies.series.affiliate_fee`; any of, required)
      - any of: `number`, `null`
    - `net` (`storeStats.response.200.currencies.series.net`; any of, required)
      - any of: `number`, `null`
    - `previous_gross` (`storeStats.response.200.currencies.series.previous_gross`; any of, required)
      - any of: `number`, `null`
    - `previous_orders` (`storeStats.response.200.currencies.series.previous_orders`; number, required)
    - `previous_refunded` (`storeStats.response.200.currencies.series.previous_refunded`; any of, required)
      - any of: `number`, `null`
    - `previous_platform_fee` (`storeStats.response.200.currencies.series.previous_platform_fee`; any of, required)
      - any of: `number`, `null`
    - `previous_processor_fee` (`storeStats.response.200.currencies.series.previous_processor_fee`; any of, required)
      - any of: `number`, `null`
    - `previous_affiliate_fee` (`storeStats.response.200.currencies.series.previous_affiliate_fee`; any of, required)
      - any of: `number`, `null`
    - `previous_net` (`storeStats.response.200.currencies.series.previous_net`; any of, required)
      - any of: `number`, `null`
  - `platform_fee` (`storeStats.response.200.currencies.platform_fee`; any of, required)
    - any of: `object`, `null`
  - `processor_fee` (`storeStats.response.200.currencies.processor_fee`; any of, required)
    - any of: `object`, `null`
  - `affiliate_fee` (`storeStats.response.200.currencies.affiliate_fee`; any of, required)
    - any of: `object`, `null`
  - `currency` (`storeStats.response.200.currencies.currency`; string, required)
  - `exponent` (`storeStats.response.200.currencies.exponent`; any of, required)
    - any of: `number`, `null`
  - `gross` (`storeStats.response.200.currencies.gross`; any of, required)
    - any of: `object`, `null`
  - `refunded` (`storeStats.response.200.currencies.refunded`; any of, required)
    - any of: `object`, `null`
- `bucket` (`storeStats.response.200.bucket`; string, required)
- `time_zone` (`storeStats.response.200.time_zone`; string, required)
- `from` (`storeStats.response.200.from`; string, required)
- `to` (`storeStats.response.200.to`; string, required)
- `previous_range` (`storeStats.response.200.previous_range`; object, required)
  - `from` (`storeStats.response.200.previous_range.from`; string, required)
  - `to` (`storeStats.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` (`storeStats.response.default.type`; string, required)
  - format `uri`
- `title` (`storeStats.response.default.title`; string, required)
- `status` (`storeStats.response.default.status`; integer, required)
- `detail` (`storeStats.response.default.detail`; string, required)
- `code` (`storeStats.response.default.code`; string, optional)
- `context` (`storeStats.response.default.context`; object, optional)
- `reached_core` (`storeStats.response.default.reached_core`; boolean, optional)
- `core_answer` (`storeStats.response.default.core_answer`; string, optional)


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