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

/reach-overlap/overlap

Get the percentage of users that currently also belongs to another 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

ids

Array of string

Array of segment identifiers.

shortIds

Array of string

Array of short segment identifiers.

names

Array of string

Site group identifier.

percents

Array of array of double

Percentage of users that currently also belongs to another segment.

siteGroupIds

Array of string

Array of site group identifiers.

values

Array of array of integer

Users count that currently also belongs to another segment.

updateTime

Long

Timestamp when report was updated.

Examples

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

{
 "ids": [
 "8nemytrw5i3a",
 "8n3jtq4m73ye",
 "8msgj8p4nzu6",
 "8msfo30vz30x",
 "8mseewg8dbwc"
 ],
 "names": [
 "New segment",
 "New segment",
 "New segment190819",
 "VD_test",
 "New segment Anton"
 ],
 "siteGroupIds": [
 "9222291112880224990",
 "9222291112880224990",
 "9222291112880224990",
 "9222291112880224990",
 "9222291112880224990"
 ],
 "values": [
 [
 151823,
 151823,
 151823,
 151823,
 151823
 ],
 [
 151823,
 151823,
 151823,
 151823,
 151823
 ],
 [
 151823,
 151823,
 151823,
 151823,
 151823
 ],
 [
 151823,
 151823,
 151823,
 151823,
 151823
 ],
 [
 151823,
 151823,
 151823,
 151823,
 151823
 ]
 ],
 "percents": [
 [
 0.995,
 1.0,
 1.0,
 1.0,
 1.0
 ],
 [
 1.0,
 0.995,
 1.0,
 1.0,
 1.0
 ],
 [
 1.0,
 1.0,
 0.995,
 1.0,
 1.0
 ],
 [
 1.0,
 1.0,
 1.0,
 0.995,
 1.0
 ],
 [
 1.0,
 1.0,
 1.0,
 1.0,
 0.995
 ]
 ]
}

Last updated: