/reach-overlap/reach | Documentation

Get the total number of unique users currently within a segment.

Request

The request object has the following fields:

Name	Type	Required	Description
`customerId`	String	Yes	Customer identifier.
`siteGroupId`	String	No	Site group identifier.
`segmentIds`	Array of String	No	Array of segment identifiers.
`limit`	Integer	No	The number of output objects (MAX 5000)
`type`	Enum	No	Segments type (USER, CONTEXTUAL, COMBINED)

Response

The response object for a successful query has the following fields:

Name	Type	Description
`reaches`	Array of object	Array of reach objects
`updateTime`	Long	Timestamp when report was updated.
`dataFrom`	Long	Timestamp when data was used.

A reach object has the following fields:

Name	Type	Description
`customerId`	String	Customer identifier.
`siteGroupId`	String	Site group identifier.
`segmentId`	String	Segment identifier.
`audience`	Long	Users count in segment
`usersPer90Days`	Long	Users count per 90 days
`usersPerMonth`	Long	Users count per month
`usersPerWeek`	Long	Users count per week
`usersPerDay`	Long	Users count per day
`viewsPer90Days`	Long	Views count per 90 days
`viewsPerMonth`	Long	Views count per month
`viewsPerWeek`	Long	Views count per week
`viewsPerDay`	Long	Views count per day
`urls`	Long	Urls count in segment
`urlsPer90Days`	Long	Urls count per 90 days
`urlsPerMonth`	Long	Urls count per month
`urlsPerWeek`	Long	Urls count per week
`urlsPerDay`	Long	Urls count per day
`success`	Boolean	Result
`name`	String	Segment name
`shortId`	String	Segment short ID

Examples

Bash

python cx.py /reach-overlap/reach '{"customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", "siteGroupId": "9222291112880224990", "limit": 5}'

{
 "reaches": [
 {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": "9222291112880224990", 
 "segmentId": "8mseewg8dbwc", 
 "audience": 151909, 
 "usersPer90Days": 0, 
 "usersPerMonth": 151909, 
 "usersPerWeek": 100498, 
 "usersPerDay": 83562, 
 "viewsPer90Days": 0, 
 "viewsPerMonth": 3855662, 
 "viewsPerWeek": 863348, 
 "viewsPerDay": 120884, 
 "success": true, 
 "name": "New segment Anton"
 }, 
 {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": "9222291112880224990", 
 "segmentId": "8msgj8p4nzu6", 
 "audience": 151909, 
 "usersPer90Days": 0, 
 "usersPerMonth": 151909, 
 "usersPerWeek": 100498, 
 "usersPerDay": 83562, 
 "viewsPer90Days": 0, 
 "viewsPerMonth": 3855662, 
 "viewsPerWeek": 863348, 
 "viewsPerDay": 120884, 
 "success": true, 
 "name": "New segment190819"
 }, 
 {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": "9222291112880224990", 
 "segmentId": "8n3jtq4m73ye", 
 "audience": 151909, 
 "usersPer90Days": 0, 
 "usersPerMonth": 151909, 
 "usersPerWeek": 100498, 
 "usersPerDay": 83562, 
 "viewsPer90Days": 0, 
 "viewsPerMonth": 3855661, 
 "viewsPerWeek": 863347, 
 "viewsPerDay": 120884, 
 "success": true, 
 "name": "New segment"
 }, 
 {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": "9222291112880224990", 
 "segmentId": "8nemytrw5i3a", 
 "audience": 151909, 
 "usersPer90Days": 0, 
 "usersPerMonth": 151909, 
 "usersPerWeek": 100498, 
 "usersPerDay": 83562, 
 "viewsPer90Days": 0, 
 "viewsPerMonth": 3855661, 
 "viewsPerWeek": 863347, 
 "viewsPerDay": 120884, 
 "success": true, 
 "name": "New segment"
 }, 
 {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": "9222291112880224990", 
 "segmentId": "8msfo30vz30x", 
 "audience": 151909, 
 "usersPer90Days": 0, 
 "usersPerMonth": 151909, 
 "usersPerWeek": 100498, 
 "usersPerDay": 83562, 
 "viewsPer90Days": 0, 
 "viewsPerMonth": 3855637, 
 "viewsPerWeek": 863347, 
 "viewsPerDay": 120884, 
 "success": true, 
 "name": "VD_test"
 }
 ]
}

Last updated: October 20, 2025