# GET Get a customiser health report

Runs the Overview health checks on the customiser and returns the issues they found, most severe first. An empty `issues` list means every check passed. `count` and `last_occurred_at` are set only for issues counted from recent shopper events, such as failed add to carts. Read-only; requires `customisers:read`. A 404 problem means the customiser is not one of this store's.

- Source URL: https://www.signcustomiser.com/help/api/v3-get-get-a-customiser-health-report/
- Markdown URL: https://www.signcustomiser.com/help/api/v3-get-get-a-customiser-health-report.md
- Group: Customisers
- OpenAPI for this group: https://www.signcustomiser.com/help/openapi/customisers.json
- Method: GET
- Path: /api/v3/customisers/{customiser_id}/health
- Auth: Bearer token
- Required scopes: `customisers:read`

## Path parameters

- customiser_id (string, required): The customiser id. Example: 1

## cURL example

```bash
curl https://web.signcustomiser.com/api/v3/customisers/1/health \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
```

## Response examples

### 200 GET 200 example 1

```json
{
  "data": {
    "object": "customiser_health",
    "customiser_id": 42,
    "checked_count": 9,
    "checked_at": "2026-11-16T09:00:00Z",
    "issues": [
      {
        "code": "cart_handoff_failed",
        "severity": "critical",
        "title": "Add to cart failed",
        "description": "3 shoppers could not add a sign to their cart in the last 7 days.",
        "count": 3,
        "last_occurred_at": "2026-11-15T18:20:00Z"
      }
    ]
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/health",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}
```

### 403 Insufficient scope

```json
{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the customisers:read scope.",
  "required_scopes": [
    "customisers:read"
  ],
  "granted_scopes": [
    "store:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
```
