Skip to main content
Anchor to customerSegmentMembersCount

customerSegmentMembersCount

query

Requires read_customers access scope.

Returns the total number of customers who match the criteria defined in a customer segment. This count provides real-time visibility into segment size for targeting and analysis purposes.

For example, check the size of a "High-Value Customers" segment before launching a VIP program.

The count reflects current segment membership based on the segment's filter criteria, updating as customer data changes and new customers meet or no longer meet the segment conditions.

Anchor to Arguments

Arguments

Anchor to queryquery
•String

The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.

Anchor to queryIdqueryId
•ID

The ID of the segment members query.

Anchor to segmentIdsegmentId
•ID

The ID of the segment.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount
•Count

A numeric count with precision information indicating whether the count is exact or an estimate.

Anchor to countcount
•Int!
non-null

The count of elements.

Anchor to precisionprecision
•CountPrecision!
non-null

The count's precision, or the exactness of the value.

Was this section helpful?