Skip to main content

PeopleSets

Returns the PeopleSets segments an audience can be built from and the families they are grouped into. Use their IDs in the peoplesets parameter when creating an audience.

Requires the PeopleSets permission (parameters.signatures), which can only be granted by StatSocial.

URL REQUEST (GET)
https://api.statsocial.com/platform/v0/peoplesets

Successful return​

Each segment lists, in regions, the regions it is built for (usa, worldwide) with the size of the audience it is built from. A segment can only be picked for a region it is listed for. Each family lists the IDs of its segments.

{
"response": {
"version": 1,
"segments": [
{
"id": "PSY-001",
"name": "Legacy Estates",
"family": "Wealth & Luxury",
"family_id": 3,
"description": "string",
"regions": {
"usa": {
"size": 125000
},
"worldwide": {
"size": 310000
}
}
}
],
"families": [
{
"id": 3,
"name": "Wealth & Luxury",
"segments": [
"PSY-001",
"PSY-002"
]
}
]
},
"information": {
"version": "0.0.1"
}
}