> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Run a reporting query > Runs a query against the store's registered metrics and dimensions, in the store's time zone. A metric or dimension the registry does not know is refused with the names that are valid, and an API key needs the read scope of every resource the query touches. **Required scope:** `read_reports` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/reporting/query openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/reporting/query: post: tags: - Reports summary: Run a reporting query description: |- Runs a query against the store's registered metrics and dimensions, in the store's time zone. A metric or dimension the registry does not know is refused with the names that are valid, and an API key needs the read scope of every resource the query touches. **Required scope:** `read_reports` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportingQueryParams' required: true responses: '200': description: query results content: application/json: example: meta: currency: USD time_range: since: '2026-01-08T00:00:00Z' until: '2026-01-15T23:59:59Z' previous_time_range: since: '2025-12-31T00:00:00Z' until: '2026-01-07T23:59:59Z' metrics: - total_sales - orders dimensions: - name: completed_at grain: day totals: total_sales: value: '110.00' previous: '0.00' growth: null display: $110.00 orders: value: 1 previous: 0 growth: null rows: - dimensions: completed_at: '2026-01-08' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-09' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-10' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-11' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-12' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-13' metrics: total_sales: value: '110.00' previous: '0.00' growth: null display: $110.00 orders: value: 1 previous: 0 growth: null - dimensions: completed_at: '2026-01-14' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' - dimensions: completed_at: '2026-01-15' metrics: total_sales: value: '0.00' previous: '0.00' growth: '0' display: $0.00 orders: value: 0 previous: 0 growth: '0' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const result = await client.reporting.query({ metrics: ['total_sales', 'orders'], dimensions: [{ name: 'completed_at', grain: 'day' }], time_range: { preset: 'last_7_days' }, compare: 'previous_period', }) - lang: bash label: Spree CLI source: >- spree api post /reporting/query -d '{"metrics":["total_sales","orders"],"dimensions":[{"name":"completed_at","grain":"day"}],"time_range":{"preset":"last_7_days"},"compare":"previous_period"}' components: schemas: ReportingQueryParams: type: object properties: metrics: type: array items: type: string description: Registered metric names, from the reporting schema endpoint. dimensions: type: array items: {} description: >- Up to 2 dimensions to break the metrics down by. Each is a dimension name, or `{ name, grain, include_empty }`: `grain` (`hour`, `day`, `week`, `month`) buckets a time dimension, and `include_empty` lists members with no matching rows where the schema entry supports it. filters: type: array items: type: object properties: dimension: type: string op: type: string enum: - eq - in value: description: One value for `eq`, a list for `in`. required: - dimension - op - value description: Narrows the rows by dimension value. metric_filters: type: array items: type: object properties: metric: type: string op: type: string enum: - eq - gt - gte - lt - lte value: type: number required: - metric - op - value description: >- Filters on an aggregate, such as `units_sold = 0`. Narrows the rows only; the totals stay the period's real figure. The metric must also appear in `metrics`, and cannot be a derived one. time_range: type: object properties: preset: type: string since: type: string until: type: string description: >- A named preset (`last_month`, `week_to_date`, any `last__`), or ISO 8601 dates or times in `since` and `until` (a bare date covers the store's whole day). Defaults to the last 30 days, in the store's time zone. compare: type: string enum: - previous_period - previous_year sort: type: string description: A metric name; prefix it with `-` to sort descending. limit: type: integer description: At most 1000. currency: $ref: '#/components/schemas/CurrencyCode' required: - metrics CurrencyCode: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.