Visitors to the shop and what they searched for
- Credentials
- OAuth access token
- Scopes
store:read- Role
- Owners and admins only. Staff get
403 forbidden. - Add-on
- Analytics plus
From the storefront's own daily tracking.
Plan: Analytics Plus (included with Growth and Scale), else 403 plan_limit. The console shows the same figures on its Sales, Products, Customers and Traffic pages only with it.
Access: OAuth scope store:read; owner or admin; not write-gated.
merchantOAuth store:readAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: store:read
storeId*stringA store the person can reach. Any other id answers 404, never 403.
days?integerHow many days back, up to now.
1 <= value <= 73030OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/reports/traffic' \ -H 'Authorization: Bearer <access_token>'{ "data": { "days": 30, "visitors": 0, "pageViews": 0, "addToCart": 0, "misses": [], "daily": [] }}Best-selling listings by revenue GET
Plan: Analytics Plus (included with Growth and Scale), else 403 `plan_limit`. The console shows the same figures on its Sales, Products, Customers and Traffic pages only with it. Access: OAuth scope `store:read`; owner or admin; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 5, at most 20) and an opaque `cursor`. It pages through the top 20.
Sales by product, month, channel or seller GET
The same tables as the console's Reports page. `rows` follow `by`. Products are capped at 50. Plan: Analytics Plus (included with Growth and Scale), else 403 `plan_limit`. The console shows the same figures on its Sales, Products, Customers and Traffic pages only with it. Access: OAuth scope `store:read`; owner or admin; not write-gated.