Sign Customiser

Navigation

Dark mode

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.

GET/api/v3/customisers/{customiser_id}/health
GETGet a customiser health report
GET/api/v3/customisers/{customiser_id}/health

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.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id.

Get a customiser health report

Click Send to see the live response.

Overview

Read-only; requires customisers:read. A 404 problem means the customiser is not one of this store's.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

Get a customiser health report
curl https://web.signcustomiser.com/api/v3/customisers/1/health \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "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"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.