Skip to main content

Dashboard

2026-10-05 — Dashboard — digital menu visits and conversion​

🆕 New

  • GET /v1/dashboard/digital-menu/today-visits — returns today's digital-menu visit count for your company, in filter[timezone] (UTC by default).
  • GET /v1/dashboard/digital-menu/performance — returns digital-menu visits, confirmed carts and created orders over a date range (filter[start_date], filter[end_date], both required), each with its previous-period value and percent variation.
  • GET /v1/dashboard/digital-menu/conversion — returns the same three metrics as percentages of visits over the same date range.

Notes

  • Reuses the existing reports:read scope.
  • Confirmed carts and created orders count only orders placed through the digital menu (upstream source: INBOUND); correlate with sales amounts by listing the orders of the same date range with GET /v1/orders.