Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Report__dashboard Overview

Returns dashboard overview statistics including: - Total orders with growth percentage - Total revenue with growth percentage - Total customers with growth percentage - Total products with new additions this week Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYreport__dashboardOverview: DashboardOverview!

Returns dashboard overview statistics including: - Total orders with growth percentage - Total revenue with growth percentage - Total customers with growth percentage - Total products with new additions this week Requires a signed-in staff user. Needs the report__Analytics read permission. Send the x-tenant header (the gateway sets it from your API key).

Returns

  1. report__dashboardOverview
customers*
orders*
products*
revenue*
Example Request
query Report__dashboardOverview {  report__dashboardOverview {    customers {      growth {        percentage        period      }      total    }    orders {      growth {        percentage        period      }      total    }  }}
Example Response
{  "data": {    "report__dashboardOverview": {      "customers": {        "growth": {          "percentage": 10.5,          "period": "string"        },        "total": 10      },      "orders": {        "growth": {          "percentage": 10.5,          "period": "string"        },        "total": 10      }    }  }}

Report__coupon Report QUERY

Discount redemptions (codes and automatic discounts) and totals for the selected dates. Optional from/to (YYYY-MM-DD). Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Report__detailed Report QUERY

Returns detailed report including: - Orders breakdown by status - Revenue and order counts by period - Top 10 selling products Optional from/to (YYYY-MM-DD) filter the report window. Without dates, revenue uses the last 6 months and other totals are all-time. Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).