Read customer cohorts
readCustomerStatsNew versus returning customers for a period, plus top locations. Aggregates only - never individual customer data.
Only for a workspace with a store connected: listWorkspaces says which are stores.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "readCustomerStats"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the range, YYYY-MM-DD, today at the latest; a range is two years at most | |
| days | No | Reporting window in days | |
| from | No | First day of a custom range, YYYY-MM-DD. With `to`, it takes the place of `days` | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| newCustomers | Yes | Customers whose first order fell in the period | |
| topLocations | Yes | Up to eight, most orders first | |
| returningCustomers | Yes | Customers who ordered in the period and had ordered before it |