Use the Household Reach API to create and manage households of users that are related by a single shared user identifier. Households can contain shared attributes, where each profile of a user in a household inherits all of the shared attributes values.
\n\nImagine you want to send a discount coupon to all of your users who own a dog, but you know that some of the users you want to reach might live in a household where only one person is identified as the dog owner.
\nBy creating a household definition for members of a household, where a household consists of users who share the same physical address, you can create an attribute has_dog (or use an existing attribute) that is inherited by all members of the household if any other member’s profile has that attribute.
You can then use the shared, or inherited, attribute when creating audiences of users.
\nFirst, we use the Household Reach API to create a new household definition for families by sending a POST API request to /platform/workspaces/{workspace_id}/groups/
The body of our request is:
\n{\n \"id\": \"household\",\n \"description\": \"users who share the same physical address\",\n \"source_user_attribute\": \"$address\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ]\n}The source_user_attribute field is how mParticle determines if a user should be added to a household. In this example, two users who share the same $address will be added to a new household.
Every household definition includes a list of household attributes in the attributes array, where each attribute is represented by an object with an id equaling the name of the user attribute to use as a household attribute and a type specifying the aggregation logic used for attribute. To learn more about household attributes and attribute aggregation logic, see Household Reach.
Household attributes are added to the profiles for all users who join a household. User profiles are updated with new household attributes daily.
\nOnce you have created a household definition, mParticle runs a search on a recurring, daily schedule looking for any users with a user attribute matching a household definition’s source_user_attribute. Users with matching attributes are added to a household instance created using the household definition. Their profiles then inherit any household attributes listed in the household’s definition.
In our example, imagine two users John Doe and Jane Doe where both John and Jane have the same address, "$address": "123 Main St". Since they share the same address, they are added to a new household using the household definition.
Both profiles for John and Jane then also display the new shared attribute has_dog. If any member of the household has a user attribute has_dog: true, then the household attribute household:has_dog=true is added to all other members of the same household. Otherwise, the value of household:has_dog remains false for all household members.
In the mParticle audience builder, we can now use our new household attributes, such as household:has_dog, as criteria to create or supplement an audience that contains users who are members of a household that has a dog. For more information on how to create audiences, see Create an audience.
The Household Reach API allows you to create household definitions. mParticle then uses these definitions to create households of users based on their shared user identifiers. This means you can create one household definition for families that results in the creation of multiple family households. (For example, all the “Jones” family members and all the “Smith” family members.)
\n\nThe Household Reach API can be authenticated using a bearer token.
\nTo create a bearer token, send a POST request to mParticle’s SSO token endpoint at https://sso.auth.mparticle.com/oauth/token.
The JSON body of the request must contain:
\nclient_id - the client ID, issued by mParticle when creating the API credentialsclient_secret - the client secret, issued by mParticle when creating the API credentialsaudience - set to a value of "https://api.mparticle.com"grant_type - set to a value of "client_credentials"curl --request POST \\\n --url https://sso.auth.mparticle.com/oauth/token \\\n --header 'content-type: application/json' \\\n --data '{\"client_id\":\"...\",\"client_secret\":\"...\",\"audience\":\"https://api.mparticle.com\",\"grant_type\":\"client_credentials\"}'POST /oauth/token HTTP/1.1\nHost: sso.auth.mparticle.com\nContent-Type: application/json\n{\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"audience\": \"https://api.mparticle.com\",\n \"grant_type\": \"client_credentials\"\n}A successful POST request to the token endpoint results in a JSON response as follows:
\n{\n \"access_token\": \"YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-\",\n \"expires_in\" : 28800,\n \"token_type\": \"Bearer\"\n}Subsequent requests to the API can then be authorized by setting the authorization header to:
\nAuthorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-
Tokens cannot be revoked, but they expire every eight hours. The initial token request can take between one and three seconds, so mParticle recommends that you cache the token and refresh it only when necessary.
\nGET https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
| Path Parameter | \nType | \nDescription | \n
|---|---|---|
{workspace_id} | \nInteger | \nThe ID of the workspace containing the household definition you want to retrieve. | \n
{group_id} | \nString | \nThe ID for the household definition you want to retrieve. | \n
curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \\\n--header 'Authorization: Bearer <access_token>'No request body.
\nA successful request receives a 200 response with a JSON object for the household.
{\n \"id\": \"neustar-household-group\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ],\n \"created_on\": \"2023-11-13T21:50:17.732Z\",\n \"created_by\": \"developer@example.com\",\n \"last_modified_on\": \"2023-11-13T21:50:17.732Z\",\n \"last_modified_by\": \"developer@example.com\"\n}GET https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/
| Path Parameter | \nType | \nDescription | \n
|---|---|---|
{workspace_id} | \nInteger | \nThe ID of the workspace containing the household definitions you want to retrieve. | \n
curl --location --request GET 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \\\n--header 'Authorization: Bearer <access_token>'No request body.
\nA successful request receives a 200 response with an array containing all households.
[\n {\n \"id\": \"neustar-household-group\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ],\n \"created_on\": \"2023-11-13T21:50:17.732Z\",\n \"created_by\": \"developer@example.com\",\n \"last_modified_on\": \"2023-11-13T21:50:17.732Z\",\n \"last_modified_by\": \"developer@example.com\"\n }\n]POST https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/
| Field | \nDescription | \n
|---|---|
id | \nA unique ID used to identify the household definition. | \n
description | \nA human readable description for the household definition. For example: users who all share the same Neustar household ID | \n
source_user_attribute | \nA single user attribute that mParticle uses to determine users’ household memberships. For example: $neustar-household-id | \n
attributes | \nAn array of household attribute objects, where each attribute contains an id and type.
| \n
curl --location --request POST 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups' \\\n--header 'Authorization: Bearer <access_token>'{\n \"id\": \"neustar-household-group\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ]\n}A successful request receives a 200 response with a JSON object for the new household.
{\n \"id\": \"neustar-household-group\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ],\n \"created_on\": \"2023-11-13T21:50:17.732Z\",\n \"created_by\": \"developer@example.com\",\n \"last_modified_on\": \"2023-11-13T21:50:17.732Z\",\n \"last_modified_by\": \"developer@example.com\"\n}PUT https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
| Path Parameter | \nType | \nDescription | \n
|---|---|---|
{workspace_id} | \nInteger | \nThe ID of the workspace containing the household definition. | \n
{group_id} | \nString | \nThe ID for the household definition you want to update. | \n
curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \\\n--header 'Authorization: Bearer <access_token>'{\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ]\n}A successful request receives a 200 response with a JSON object for the household.
{\n \"id\": \"group-id\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n }\n ],\n \"created_on\": \"2023-11-13T21:53:57.917Z\",\n \"created_by\": \"developer@example.com\",\n \"last_modified_on\": \"2023-11-13T21:53:57.917Z\",\n \"last_modified_by\": \"developer@example.com\"\n}PATCH https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
| Path Parameter | \nType | \nDescription | \n
|---|---|---|
{workspace_id} | \nInteger | \nThe ID of the workspace containing the household definition. | \n
{group_id} | \nString | \nThe ID for the household definition you want to add attributes to. | \n
curl --location --request PUT 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \\\n--header 'Authorization: Bearer <access_token>'{\n \"attributes\": [\n {\n \"id\": \"has_dog\",\n \"type\": \"boolean_or\"\n },\n {\n \"id\": \"country\",\n \"type\": \"latest\"\n }\n ]\n}A successful request receives a 200 response with a JSON object for the household.
{\n \"id\": \"group-id\",\n \"description\": \"A group of users related by shared Neustar household ID\",\n \"source_user_attribute\": \"neustar-household-id\",\n \"attributes\": [\n {\n \"id\": \"id of the attribute shared by the group\",\n \"type\": \"either 'latest' or 'boolean_or'\"\n }\n ],\n \"created_on\": \"2023-11-13T21:57:26.947Z\",\n \"created_by\": \"developer@example.com\",\n \"last_modified_on\": \"2023-11-13T21:57:26.947Z\",\n \"last_modified_by\": \"developer@example.com\"\n}DELETE https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}
| Path Parameter | \nType | \nDescription | \n
|---|---|---|
{workspace_id} | \nInteger | \nThe ID of the workspace containing the household definition you want to delete. | \n
{group_id} | \nString | \nThe ID of the household definition you want to delete. | \n
curl --location --request DELETE 'https://api.mparticle.com/platform/workspaces/{workspace_id}/groups/{group_id}' \\\n--header 'Authorization: Bearer <access_token>'No request body.
\nA successful request receives a 204 response with an empty body.
| Limit | \nDescription | \n
|---|---|
| Household ID | \nMust be between 3 and 32 characters | \n
| Household description | \nMust be between 0 and 255 characters | \n
| Household attribute IDs | \nMust be between 1 and 223 characters | \n
| Number of household definitions per workspace | \n1 | \n
| Number of attributes per household | \n10 | \n
| Number of users per household | \n10 | \n
| Response code | \nError message | \nDescription | \n
|---|---|---|
| 400 | \nNo user ID provided | \nYou must provide a valid user ID when attempting to view a user. | \n
| 401 | \nUnauthorized | \nVerify that you have created the correct API credentials for the Household Reach API and that you are using the correct authentication method. | \n
| 403 | \nForbidden | \nVerify that you have created the correct API credentials for the Household Reach API and that you are using the correct authentication method. | \n
| 404 | \nNot found | \nThe specified resource was not found. | \n
| 422 | \nUnprocessable entity | \nThe request was understood but cannot be processed. | \n