Skip to content

customerReport

View normalized Markdown

Count customer records using the same filters as exports. Requires reports:read and contacts:read.

graphql
customerReport(
  filter: CustomerFilter
  metric: CustomerReportInput!
): ReportResult

Arguments

customerReport.filter · CustomerFilter input

Source filters applied before aggregation.

customerReport.metric · CustomerReportInput! non-null input

Grouping and count aggregation.

Type

ReportResult object

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