Needs the transaction:read scope.
Call
- Tool:
traffic_stats - Scope:
transaction:read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
from |
string |
No | |
to |
string |
No | |
bucket |
"day" or "week" or "month" |
No |
{
"type": "object",
"properties": {
"store": {
"type": "string",
"description": "The store to act on."
},
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
},
"bucket": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
time_zone |
string |
Yes | |
from |
string |
Yes | |
to |
string |
Yes | |
previous_range |
object |
Yes | |
bucket |
string |
Yes | |
rolled_through |
string or null |
Yes | The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet. |
covered_from |
string or null |
Yes | The earliest store-local day the totals hold, null before the first; earlier days count nothing. |
views |
object |
Yes | Pages, products and entries shown, scaled back from sampling. |
visitors |
object |
Yes | Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one person on three days counts three times. |
estimated |
boolean |
Yes | Counted from sampled data, so the figures are estimates. |
sign_ins |
object |
Yes | Customers signing in, a new sign-up included. |
sign_ups |
object |
Yes | Customers signing in for the first time. |
by_event |
array of object |
Yes | |
by_channel |
array of object |
Yes | By the channel each view came through: web, api, mcp or feed. |
by_country |
array of object |
Yes | By the visitor’s country, null where it is unknown. |
top_products |
object |
Yes | The most viewed products in the range, and how many were viewed at all. |
series |
array of object |
Yes | |
sources |
object |
Yes |
The answer’s full shape is on its API reference page.
Errors
A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:
invalid: an argument is malformed;context.pathnames it.invalidat["store"]:storeis missing while the connection reaches more than one store, or names a store it doesn’t reach.not_permitted: this connection may not make this call. Whencontext.reasonislimit, too many calls:retry_aftersays when to try again.internalorunavailable: the call failed inside Sherpo. A read markedtransientmay be retried.client-fault: the server failed around the call.reached_coresays whether it reached Sherpo; the call may be made again.- HTTP 403 with
insufficient_scope: the connection lacks the scope this tool needs. - HTTP 401 with
invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.
Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.