Skip to content

addressReport

View normalized Markdown

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

graphql 
addressReport(
  filter: AddressFilter
  metric: AddressReportInput!
): ReportResult

Arguments

addressReport.filter · AddressFilter input

Source filters applied before aggregation.

addressReport.metric · AddressReportInput! 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.