We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/reach-overlap/summary

Summary report. Contains information for all segments in site group.

Request

The request object has the following fields:

Name

Type

Required

Description

customerId

String

Yes (Admin only)

Customer identifier.

siteGroupId

String

No

Site group identifier.

siteGroups

Array of Strings

No

Array of site group identifier. Will be used only first site group id (deprecated)

Response

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

Name

Type

Description

summary

Object

Summary report.

updateTime

Long

Timestamp when report was updated.

dataFrom

Long

Timestamp when data was used.

A summary object has the following fields:

Name

Type

Description

customerId

String

Customer identifier.

siteGroupId

String

Site group identifier.

totalUsers

Long

Total count users.

segmentedUsers

Long

Segmented users.

totalPageViews

Long

Total count page views.

segmentPageViews

Long

Segmented page views.

days

Integer

Days count.

Examples

Bash
python cx.py /reach-overlap/summary '{"customerId": "eec9d6e2f5a068470ecf37559af83f92d9cfd160", "siteGroupId": "9222291112880224990", "limit": 100}'
{
 "summary": {
 "customerId": "6a82ea610f586ffabcddb5cac81b0ec3754d15c2", 
 "siteGroupId": null, 
 "totalUsers": 152563, 
 "segmentedUsers": 152204, 
 "totalPageViews": 3888651, 
 "segmentPageViews": 3885966, 
 "days": 30
 }, 
 "updateTime": 1566871163, 
 "dataFrom": 1566864000
}

Last updated: