Customisers
Get a customiser performance report
Returns the Overview performance card: customiser loads, sales, orders,
add to carts, quote requests, form submissions, AI designs and shared
designs for range (7, 30 or 90 days, default 30) against the period
before it, with a daily series. Days are counted in timezone (an IANA
name, default UTC).
Overview
Money is in minor units of currency, the currency
with the most sales in the period; orders in other currencies are counted in
other_currency_orders only. The report is cached for up to five
minutes. Read-only; requires analytics:read.
A 404 problem means the customiser is not one of this store's. A 422
problem with code invalid_parameter names a range or timezone that
is not allowed.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: analytics:read
Path parameters
The customiser id.
Example: 1
Query parameters
One of `7d`, `30d` or `90d`. Defaults to `30d`.
Example: 7d
An IANA timezone for day boundaries. Defaults to `UTC`.
Example: Australia/Sydney
curl https://web.signcustomiser.com/api/v3/customisers/1/performance?range=7d&timezone=Australia%2FSydney \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'{
"data": {
"object": "customiser_performance",
"customiser_id": 42,
"range": "7d",
"period_from": "2026-11-10",
"period_to": "2026-11-16",
"previous_period_from": "2026-11-03",
"previous_period_to": "2026-11-09",
"mode": "sales",
"currency": "USD",
"other_currency_orders": 0,
"loads": {
"value": 120,
"previous": 100,
"change_percent": 20
},
"sales": {
"value_minor": 45000,
"previous_minor": 30000,
"change_percent": 50
},
"orders": {
"value": 3,
"previous": 2,
"change_percent": 50,
"average_order_minor": 15000
},
"add_to_carts": {
"value": 6,
"previous": 4,
"change_percent": 50
},
"cart_to_order": {
"ordered_carts": 3,
"carts": 6,
"rate_percent": 50,
"previous_rate_percent": 50,
"change_points": 0
},
"quote_requests": {
"value": 0,
"previous": 0,
"change_percent": null
},
"form_submissions": {
"value": 1,
"previous": 0,
"change_percent": null,
"quote": 0,
"custom_design": 1
},
"ai_designs": {
"value": 4,
"previous": 1,
"change_percent": 300,
"delivered": 4,
"added_to_cart": 1
},
"shared_designs": {
"value": 0,
"previous": 0,
"change_percent": null
},
"series": [
{
"date": "2026-11-16",
"previous_date": "2026-11-09",
"sales_minor": 15000,
"previous_sales_minor": 0,
"quotes": 0,
"previous_quotes": 0
}
]
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/customisers/42/performance?range=7d",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the analytics:read scope.",
"required_scopes": [
"analytics:read"
],
"granted_scopes": [
"customisers:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}