Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Report__detailed Report

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).

QUERYreport__detailedReport(from: String, to: String): DetailedReport!

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).

Arguments

from?String
to?String

Returns

  1. report__detailedReport
ordersByPeriod*
ordersByStatus*
revenueByMonth*
topProducts*
Example Request
query Report__detailedReport {  report__detailedReport {    ordersByPeriod {      count      period    }    ordersByStatus {      count      status    }  }}
Example Response
{  "data": {    "report__detailedReport": {      "ordersByPeriod": [        {          "count": 10,          "period": "string"        }      ],      "ordersByStatus": [        {          "count": 10,          "status": "string"        }      ]    }  }}

Report__dashboard Overview QUERY

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).

Report__stock Report QUERY

Current stock mix plus movements in the selected dates. Optional from/to (YYYY-MM-DD). Stock levels are a live snapshot. 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).