Skip to main content

PeopleSets

Returns the PeopleSets composition of the insight in a region. Of the insight's profiles placed in any PeopleSets segment, it gives the share whose primary segment is each segment (segments), and the share whose primary segment is in each family (families), against the baseline's share. A region's shares sum to 1.

Requires the PeopleSets report section permission, which can only be granted by StatSocial. Insights generated before PeopleSets were counted have no composition and return an error.

Getting Started​

region: usa or worldwide

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

hash: Insight hash

https://api.statsocial.com/platform/v0/reports/peoplesets/usa?hash=xxxx

Can send a default baseline.
Available types: global, global_males, global_females, usa, usa_males, usa_females,UK, Canada, France, Germany, Italy, Spain, or any other insight hash.
If no baseline is specified, it defaults to global.

https://api.statsocial.com/platform/v0/reports/peoplesets/usa?hash=xxxx&baseline=usa

Successful return​

values and indexes hold one entry per insight hash.

{
"information": {
"version": "string"
},
"response": {
"hashes": [
"string"
],
"baseline": "string",
"baseline_alias": "string",
"region": "usa",
"segments": [
{
"id": "PSY-001",
"name": "Legacy Estates",
"family": "Wealth & Luxury",
"family_id": 3,
"description": "string",
"baseline": 0.02,
"values": [
0.04
],
"indexes": [
200
]
}
],
"families": [
{
"id": "3",
"name": "Wealth & Luxury",
"children_count": 8,
"baseline": 0.1,
"values": [
0.15
],
"indexes": [
150
]
}
]
}
}