Report on one store
get_reportReports on one store the person owns, one area at a time, with the dashboard's own figures. results: per-day figures and totals for the period (conversations, cart adds, orders and revenue from chat, ratings, popups, unanswered questions), the products the chat showed and added to the cart most, the pages it answered from, and handoffs to the team. inbox: shoppers waiting for the team now, requests awaiting follow-up, missed requests, open unanswered questions, low-rated chats to review and customer email counts. catalog: product and page counts, catalogue health, promoted products, sync status and sync problems (dates and counts), and the plugin version. settings: the chat's look and texts per language, popups, team hours and away messages, rules and their status, alert channel kinds, allowed sites, the country filter and switches. billing: spend and usage this period, credit left, the monthly cap and how much of it is used. Counts, catalogue data and settings only: no conversation or email text, nothing a shopper wrote, no contact details and no secrets. dashboard_url opens the matching dashboard page for this store.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"store_id": "<store_id>",
"area": "<area>"
},
"name": "get_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | Yes | ||
| period | No | The days results and inbox cover, in UTC: the last 7, 30 or 90 days, or mtd (this month so far). The other areas are as they stand now. | 30d |
| store_id | Yes | The store's store_id (not its name). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | ||
| area | Yes | ||
| from | No | ||
| name | No | ||
| inbox | No | ||
| billing | No | ||
| catalog | No | ||
| results | No | ||
| settings | No | ||
| store_id | Yes | ||
| dashboard_url | Yes | ||
| dashboard_pages | Yes |