Sign Customiser

Navigation

Dark mode

Analytics

get_customiser_performance

read

Get customiser performance

Copy page

See how one customiser is trading, for example before suggesting a change to it.

Overview

Returns the Overview performance report of one customiser for the last 7, 30 or 90 days against the period before it: customiser loads, sales, orders, add to carts, cart to order rate, quote requests, form submissions, AI designs and shared designs, with a daily series. Money is in integer minor units of currency, the currency with the most sales; orders in other currencies are counted in other_currency_orders only. It contains no customer personal data. It requires the analytics:read scope and has no side effects.

Permission

Requires theanalytics:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A customiser id from list_customisers.
  • A merchant has connected this store and approved the analytics:read scope.

Arguments

customiser_idintegerrequired

The customiser id, from list_customisers.

rangestring

How many days to report over. Defaults to 30d.

One of: 7d, 30d, 90d

timezonestring

The IANA timezone that sets the day boundaries, such as Australia/Sydney. Defaults to UTC.

Result

The performance report: the periods, the mode (sales or quote), the currency, each metric with its previous value and change, and the daily series.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
customiser_idintegeralways present
performanceobjectalways present

The performance report, in the shape getCustomiserPerformance returns.

Error cases

insufficient_scope

The connection was approved without analytics:read.

invalid_parameter

range is not 7d, 30d or 90d, or timezone is not an IANA timezone name.

resource_not_found

No customiser with that id belongs to this store. Use list_customisers.

The last seven days

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_customiser_performance",
    "arguments": {
      "customiser_id": 42,
      "range": "7d"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "customiser_id": 42,
      "performance": {
        "range": "7d",
        "period_from": "2026-11-10",
        "period_to": "2026-11-16",
        "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
        }
      }
    }
  }
}

A customiser id from another store (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_customiser_performance",
    "arguments": {
      "customiser_id": 999
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "resource_not_found",
        "title": "Resource not found",
        "detail": "The requested resource does not exist or does not belong to the authenticated store.",
        "recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
      }
    }
  }
}

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