orderReport

Aggregate order data. Requires reports:read and source scopes; monetary metrics require finance:read and currency.

orderReport(
  currency: String
  filter: OrderFilter
  metric: OrderReportInput!
): ReportResult

Arguments

orderReport.currency · String scalar

Required for monetary metrics. Only source amounts in this currency contribute.

orderReport.filter · OrderFilter input

Filter the complete source dataset before aggregation.

orderReport.metric · OrderReportInput! non-null input

One report definition.

Type

ReportResult object

Complete aggregate results for the selected filters; excessive group counts fail instead of being truncated.