{"_id":"59e70b9ee027ae002e7d2eed","category":{"_id":"59e70b9ee027ae002e7d2ed6","version":"59e70b9ee027ae002e7d2ed2","project":"5496d393f52a630b00519cdd","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-12-21T18:05:46.941Z","from_sync":false,"order":3,"slug":"rest-api","title":"REST API"},"project":"5496d393f52a630b00519cdd","user":"5496d353f52a630b00519cdc","parentDoc":null,"version":{"_id":"59e70b9ee027ae002e7d2ed2","project":"5496d393f52a630b00519cdd","__v":2,"createdAt":"2017-10-18T08:06:54.462Z","releaseDate":"2017-10-18T08:06:54.462Z","categories":["59e70b9ee027ae002e7d2ed3","59e70b9ee027ae002e7d2ed4","59e70b9ee027ae002e7d2ed5","59e70b9ee027ae002e7d2ed6","59e70b9ee027ae002e7d2ed7","59e70b9ee027ae002e7d2ed8","59e70b9ee027ae002e7d2ed9","59e70b9ee027ae002e7d2eda","59e70b9ee027ae002e7d2edb","59e70b9ee027ae002e7d2edc","59e70b9ee027ae002e7d2edd","59e70b9ee027ae002e7d2ede","59e70b9ee027ae002e7d2edf","5b8661ccdd19310003a3fa0b"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.10","version":"2.0.10"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-22T07:46:39.496Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameters\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Relevant only for User_ID queries.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"active_since\\n*(optional)*\",\n    \"0-1\": \"Filters results to devices that were active since a specific date.\",\n    \"0-2\": \"YYYY-MM-DD\",\n    \"0-3\": \"2013-12-25\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"gender\",\n    \"0-1\": \"The user’s gender\",\n    \"0-2\": \"[Gender Structure](#section-gender-structure)\",\n    \"0-3\": \"e0fc05c3478926023a8607029f012f9f62bb4590\",\n    \"1-0\": \"age\",\n    \"3-0\": \"home\",\n    \"4-0\": \"work\",\n    \"5-0\": \"household_income\",\n    \"6-0\": \"interests\",\n    \"7-0\": \"in_market_for\",\n    \"8-0\": \"personas\",\n    \"9-0\": \"transits\",\n    \"10-0\": \"flights\",\n    \"11-0\": \"religion\",\n    \"11-1\": \"The user’s religion information. This attribute is returned as a list, although only in rare and unique cases more than one value will be returned.\",\n    \"10-1\": \"The user’s flights information\",\n    \"9-1\": \"The user’s transportation habits\",\n    \"8-1\": \"Contains a list of personas that matches the user’s behaviour. The list is returned as a JSON array.\",\n    \"7-1\": \"Contains a list of products or services the user is currently interested in buying. The list is returned as a JSON array.\",\n    \"6-1\": \"Contains a list of recreational and professional topics that the user is interested in.  Interests are returned as a JSON array.\",\n    \"5-1\": \"The user’s household income\",\n    \"4-1\": \"The user’s workplace information. Since users might have more than one workplace, work is returned as a JSON array\",\n    \"3-1\": \"The user’s home information. Since users might have more than one home, home is returned as a JSON Array.\",\n    \"1-1\": \"The user’s age\",\n    \"3-2\": \"[Home Structure](#section-home-structure)\",\n    \"1-2\": \"[Age Structure](#section-age-structure)\",\n    \"5-2\": \"[Household Income Structure](#section-household-income-structure)\",\n    \"4-2\": \"[Work Structure](#section-work-structure)\",\n    \"8-2\": \"[Personas Structure](#section-personas-structure)\",\n    \"7-2\": \"[In the Market Structure](#section-in-the-market-structure)\",\n    \"6-2\": \"[Interests Structure](#section-interests-structure)\",\n    \"9-2\": \"[Transits Structure](#section-transits-structure)\",\n    \"10-2\": \"[Flights Structure](#section-flights-structure)\",\n    \"11-2\": \"[Religion Structure](#section-religion-structure)\",\n    \"2-0\": \"ethnicity\",\n    \"2-1\": \"The user's ethnic groups segmentation with probability scores.\",\n    \"2-2\": \"JSON Array of [Ethnicity Structure](#section-ethnicity-structure)\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\n##Gender Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"gender\",\n    \"0-1\": \"User’s estimated gender: Male or Female\",\n    \"0-2\": \"String\",\n    \"0-3\": \"male\",\n    \"1-0\": \"confidence\",\n    \"1-1\": \"“gender” confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"1-2\": \"String\",\n    \"1-3\": \"high\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##Age Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"min\",\n    \"1-0\": \"max\",\n    \"2-0\": \"confidence\",\n    \"2-1\": \"“age” confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"1-1\": \"User’s estimated maximal age group.\",\n    \"0-1\": \"User’s estimated minimal age group.\",\n    \"0-2\": \"Int\",\n    \"1-2\": \"Int\",\n    \"2-2\": \"String\",\n    \"2-3\": \"high\",\n    \"1-3\": \"32\",\n    \"0-3\": \"25\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n##Ethnicity Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"name\",\n    \"0-1\": \"The ethnic group name. Currently supported: White, Black, Asian and Latino.\",\n    \"1-0\": \"probability\",\n    \"1-1\": \"The ethnic group's probability score. Ranges from 0 to 100.\",\n    \"0-3\": \"Latino\",\n    \"0-2\": \"String\",\n    \"1-2\": \"Int\",\n    \"1-3\": \"77\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##Home Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"place\",\n    \"1-0\": \"is_primary\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"1-3\": \"True\",\n    \"1-2\": \"Boolean\",\n    \"1-1\": \"In case of multiple home address, this parameter is used to distinct between the primary and the secondaries.\",\n    \"0-1\": \"Home location details and statistic data.\",\n    \"0-2\": \"[Place](doc:place)  Structure\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##Work Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-3\": \"Banker\",\n    \"0-2\": \"String\",\n    \"0-1\": \"User’s occupation description. For example:\\n  * Driver / Delivery / Field service\\n  * Housewife\\n  * Unemployed / Works from home\\n  * High School Student\\n  * Law School Student\\n  * Medical School Student\\n  * College\\n  * University\\n  * Other\",\n    \"0-0\": \"occupation\",\n    \"1-0\": \"job_type\",\n    \"1-1\": \"Can be one of the following:\\n  * full_time_job\\n  * part_time_job\",\n    \"1-2\": \"String\",\n    \"1-3\": \"full_time_job\",\n    \"2-0\": \"place\",\n    \"2-1\": \"Workplace location detail, venue information and statistic data.\",\n    \"2-2\": \"[Place](doc:place)  Structure\",\n    \"3-0\": \"work_days\",\n    \"4-0\": \"weekly_work_hours\",\n    \"5-0\": \"is_primary\",\n    \"3-1\": \"A 7 cells length array with boolean values to mark the working days.\\n\\nFirst cell is equivalent to Monday.\",\n    \"4-1\": \"Estimated number of working hours per week\",\n    \"5-1\": \"In case of multiple occupations, this parameter is used to distinct between the primary and the secondaries.\",\n    \"5-2\": \"Boolean\",\n    \"5-3\": \"true\",\n    \"4-2\": \"Int\",\n    \"4-3\": \"44\",\n    \"3-2\": \"Array[7]\",\n    \"3-3\": \"[true, true, true, true, true, false, false] - Work days are from Monday to Friday\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n##Household Income Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"min\",\n    \"1-0\": \"max\",\n    \"2-0\": \"confidence\",\n    \"2-1\": \"“household_income” confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"1-1\": \"The user’s estimated maximum annual household income in USD.\",\n    \"0-1\": \"The user’s estimated minimum annual household income in USD.\",\n    \"0-2\": \"Int\",\n    \"1-2\": \"Int\",\n    \"2-2\": \"String\",\n    \"2-3\": \"high\",\n    \"1-3\": \"125000\",\n    \"0-3\": \"100000\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n##Interests Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"1-0\": \"confidence\",\n    \"1-1\": \"This interest confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"1-2\": \"String\",\n    \"1-3\": \"high\",\n    \"0-1\": \"A user’s interest. The following is the list of Placer’s top interests:\\n  * Athletics & Sports\\n  * Cafés\\n  * Children Entertainment\\n  * Cosmetics\\n  * Dining\\n  * Fine Arts\\n  * Fitness\\n  * Gambling\\n  * Grocery Shopping\\n  * Live Music\\n  * Live Sports\\n  * Movies\\n  * Nightlife\\n  * Pets\\n  * QSR\\n  * Shopping\\n  * Ski\",\n    \"0-2\": \"String\",\n    \"0-3\": \"”Live Sports”\",\n    \"0-0\": \"interest\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##In-the-Market Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"product\",\n    \"1-0\": \"confidence\",\n    \"1-1\": \"This product purchase intent confidence level. Can be of the following: “high”, ”medium” or ”low”.\",\n    \"1-2\": \"String\",\n    \"1-3\": \"high\",\n    \"0-3\": \"“Car Insurance”\",\n    \"0-2\": \"String\",\n    \"0-1\": \"A tangible product or service the user is interested in. For example:\\n  * Car\\n  * Car Insurance\\n  * Travel\\n  * Kids Toys\\n  * Appliances\\n  * Dating Services\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##Personas Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"persona\",\n    \"1-0\": \"confidence\",\n    \"0-1\": \"A persona that matches the user. \\nFor example:\\n  * Mom\\n  * New Mom\\n  * Soccer Mom\\n  * Single\\n  * High Net-Worth Individual\\n  * Health & Fitness Enthusiasts\\n  * Fashionistas\\n  * Business Traveler\\n  * Leisure Traveler\\n  * Bookworm\\n  * Engineering Enthusiasts\",\n    \"0-2\": \"String\",\n    \"0-3\": \"“Soccer Mom”\",\n    \"1-1\": \"This persona confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"1-2\": \"String\",\n    \"1-3\": \"high\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n##Transits Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"avg_kms_per_day\",\n    \"1-0\": \"main_transportation\",\n    \"2-0\": \"degree\",\n    \"2-1\": \"Number between 0 to 10 which represents the user’s traveled KM statistic decile compared to all of Placer’s users.\",\n    \"1-1\": \"Can be one of the following:\\n  * Car or taxi\\n  * Bus\\n  * Train\",\n    \"1-2\": \"string\",\n    \"0-2\": \"float\",\n    \"0-3\": \"35.1\",\n    \"1-3\": \"Bus\",\n    \"2-2\": \"int\",\n    \"2-3\": \"9\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n##Flights Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"yearly_count\",\n    \"1-0\": \"degree\",\n    \"2-0\": \"confidence\",\n    \"2-1\": \"“yearly_count” confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"2-2\": \"string\",\n    \"2-3\": \"high\",\n    \"1-1\": \"Number between 0 to 10 that represents the user’s flights per year statistic decile compared to all of Placer’s users.\",\n    \"0-1\": \"Estimated number of flights per year.\",\n    \"0-2\": \"int\",\n    \"1-2\": \"int\",\n    \"0-3\": \"4\",\n    \"1-3\": \"9\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n##Religion Structure\n*[Back to top](#response)* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"0-0\": \"religion\",\n    \"1-0\": \"confidence\",\n    \"1-1\": \"“religion” confidence level. Can be one of the following: “high”, ”medium” or ”low”.\",\n    \"0-1\": \"The user’s religion: Christian, Jewish, Muslim, etc.\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"0-3\": \"Christian\",\n    \"1-3\": \"high\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"total_count\\\": 1,\\n  \\\"error_code\\\": 0,\\n  \\\"data\\\": [\\n    {\\n      \\\"insights\\\": {\\n        \\\"interests\\\": [\\n          {\\n            \\\"confidence\\\": \\\"high\\\",\\n            \\\"interest\\\": \\\"Travel\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"high\\\",\\n            \\\"interest\\\": \\\"Higher Education\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"high\\\",\\n            \\\"interest\\\": \\\"Café\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"low\\\",\\n            \\\"interest\\\": \\\"Grocery Shopping\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"low\\\",\\n            \\\"interest\\\": \\\"Dining\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"low\\\",\\n            \\\"interest\\\": \\\"Ski\\\"\\n          },\\n          {\\n            \\\"confidence\\\": \\\"low\\\",\\n            \\\"interest\\\": \\\"Arts & Crafts\\\"\\n          }\\n        ],\\n        \\\"work\\\": [\\n          {\\n            \\\"weekly_work_hours\\\": 5,\\n            \\\"is_primary\\\": true,\\n            \\\"job_type\\\": \\\"Part time job\\\",\\n            \\\"work_days\\\": [\\n              true,\\n              true,\\n              true,\\n              true,\\n              true,\\n              false,\\n              false\\n            ],\\n            \\\"place\\\": {\\n              \\\"estimated_address\\\": {\\n                \\\"city\\\": \\\"Escondido Village\\\",\\n                \\\"country\\\": \\\"United States\\\",\\n                \\\"state\\\": \\\"CA\\\",\\n                \\\"formatted_city\\\": \\\"Escondido Village, CA, United States\\\",\\n                \\\"postal_code\\\": \\\"94305.0\\\",\\n                \\\"formatted_address\\\": \\\"340 Olmsted Road, Escondido Village, CA, United States\\\",\\n                \\\"street_address\\\": \\\"340 Olmsted Road\\\"\\n              },\\n              \\\"estimated_geolocation\\\": {\\n                \\\"lat\\\": 37.42533289095223,\\n                \\\"long\\\": -122.15375128758956,\\n                \\\"accuracy\\\": 8.625326029288335\\n              },\\n              \\\"venue_info\\\": {\\n                \\\"category\\\": \\\"Stadium\\\",\\n                \\\"geolocation\\\": {\\n                  \\\"lat\\\": 37.426074392968005,\\n                  \\\"long\\\": -122.15462213417152\\n                },\\n                \\\"venue_id\\\": \\\"4ea335bb722ec75adea438d8\\\",\\n                \\\"name\\\": \\\"Washington Warmup-Stanford\\\",\\n                \\\"probability\\\": 0.5803318477173641,\\n                \\\"venue_provider\\\": \\\"Foursquare\\\",\\n                \\\"sub_category\\\": \\\"Stadium\\\"\\n              },\\n              \\\"first_visit_time\\\": \\\"2015-11-04T22:52:57.238Z\\\",\\n              \\\"last_visit_time\\\": \\\"2015-12-30T18:21:47.571Z\\\",\\n              \\\"type\\\": \\\"Work\\\",\\n              \\\"id\\\": \\\"563aa0b46f868794271bd56e\\\"\\n            },\\n            \\\"occupation\\\": \\\"Other\\\"\\n          }\\n        ],\\n        \\\"flights\\\": {\\n          \\\"yearly_count\\\": 2\\n        },\\n        \\\"household_income\\\": {\\n          \\\"max\\\": 75000,\\n          \\\"confidence\\\": \\\"low\\\",\\n          \\\"min\\\": 60000\\n        },\\n        \\\"brands\\\": [\\n          {\\n            \\\"confidence\\\": \\\"high\\\",\\n            \\\"place_ids\\\": [\\n              \\\"56412b8f6f86b9dfb5ef8d88\\\",\\n              \\\"5644e4f16f8632e528976025\\\",\\n              \\\"564a58c5e4b059280e3b0a4e\\\"\\n            ],\\n            \\\"type\\\": \\\"food\\\",\\n            \\\"name\\\": \\\"Starbucks\\\"\\n          }\\n        ],\\n        \\\"home\\\": [\\n          {\\n            \\\"is_primary\\\": true,\\n            \\\"place\\\": {\\n              \\\"estimated_address\\\": {\\n                \\\"city\\\": \\\"Escondido Village\\\",\\n                \\\"country\\\": \\\"United States\\\",\\n                \\\"state\\\": \\\"CA\\\",\\n                \\\"formatted_city\\\": \\\"Escondido Village, CA, United States\\\",\\n                \\\"postal_code\\\": \\\"94305.0\\\",\\n                \\\"formatted_address\\\": \\\"103 Hoskins Court, Escondido Village, CA, United States\\\",\\n                \\\"street_address\\\": \\\"103 Hoskins Court\\\"\\n              },\\n              \\\"estimated_geolocation\\\": {\\n                \\\"lat\\\": 37.42642624277531,\\n                \\\"long\\\": -122.15600842597217,\\n                \\\"accuracy\\\": 4.883181473508882\\n              },\\n              \\\"first_visit_time\\\": \\\"2015-11-05T00:05:14.244Z\\\",\\n              \\\"last_visit_time\\\": \\\"2016-01-06T03:01:14.644Z\\\",\\n              \\\"type\\\": \\\"Home\\\",\\n              \\\"id\\\": \\\"563aa0b46f868794271bd56f\\\"\\n            }\\n          }\\n        ],\\n        \\\"transits\\\": {\\n          \\\"avg_kms_per_day\\\": 11.326217651367188\\n        },\\n        \\\"ethnicity\\\": [\\n          {\\n            \\\"ethnicity\\\": \\\"White\\\",\\n            \\\"probability\\\": 48\\n          },\\n          {\\n            \\\"ethnicity\\\": \\\"Asian\\\",\\n            \\\"probability\\\": 26\\n          },\\n          {\\n            \\\"ethnicity\\\": \\\"Latino\\\",\\n            \\\"probability\\\": 14\\n          },\\n          {\\n            \\\"ethnicity\\\": \\\"Black\\\",\\n            \\\"probability\\\": 5\\n          }\\n        ]\\n      },\\n      \\\"device_id\\\": \\\"563a96eafdef261ed41d43e9\\\"\\n    }\\n  ],\\n  \\\"result\\\": \\\"SUCCESS\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"1 -  HTTPS api.placer.io/v2/apps/**APP_KEY**/users/**USER_ID**/insights\n\n2 -  HTTPS api.placer.io/v2/apps/**APP_KEY**/devices/**DEVICE_ID**/insights\n\n*This API provides Placer user’s insights, such as: gender, age, religion, interests, etc. *\n\nPlacer’s insights are related to device_id. If user_id is used to query (the first query URL template), results will be returned as a list of related device_ids with insights for each device. For further details see [User_ID & Device_ID](doc:user_id--device_id).","slug":"user-insights","type":"endpoint","title":"Insights"}

getInsights

1 - HTTPS api.placer.io/v2/apps/**APP_KEY**/users/**USER_ID**/insights 2 - HTTPS api.placer.io/v2/apps/**APP_KEY**/devices/**DEVICE_ID**/insights *This API provides Placer user’s insights, such as: gender, age, religion, interests, etc. * Placer’s insights are related to device_id. If user_id is used to query (the first query URL template), results will be returned as a list of related device_ids with insights for each device. For further details see [User_ID & Device_ID](doc:user_id--device_id).

[block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:callout] { "type": "warning", "body": "Relevant only for User_ID queries." } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "active_since\n*(optional)*", "0-1": "Filters results to devices that were active since a specific date.", "0-2": "YYYY-MM-DD", "0-3": "2013-12-25" }, "cols": 4, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "gender", "0-1": "The user’s gender", "0-2": "[Gender Structure](#section-gender-structure)", "0-3": "e0fc05c3478926023a8607029f012f9f62bb4590", "1-0": "age", "3-0": "home", "4-0": "work", "5-0": "household_income", "6-0": "interests", "7-0": "in_market_for", "8-0": "personas", "9-0": "transits", "10-0": "flights", "11-0": "religion", "11-1": "The user’s religion information. This attribute is returned as a list, although only in rare and unique cases more than one value will be returned.", "10-1": "The user’s flights information", "9-1": "The user’s transportation habits", "8-1": "Contains a list of personas that matches the user’s behaviour. The list is returned as a JSON array.", "7-1": "Contains a list of products or services the user is currently interested in buying. The list is returned as a JSON array.", "6-1": "Contains a list of recreational and professional topics that the user is interested in. Interests are returned as a JSON array.", "5-1": "The user’s household income", "4-1": "The user’s workplace information. Since users might have more than one workplace, work is returned as a JSON array", "3-1": "The user’s home information. Since users might have more than one home, home is returned as a JSON Array.", "1-1": "The user’s age", "3-2": "[Home Structure](#section-home-structure)", "1-2": "[Age Structure](#section-age-structure)", "5-2": "[Household Income Structure](#section-household-income-structure)", "4-2": "[Work Structure](#section-work-structure)", "8-2": "[Personas Structure](#section-personas-structure)", "7-2": "[In the Market Structure](#section-in-the-market-structure)", "6-2": "[Interests Structure](#section-interests-structure)", "9-2": "[Transits Structure](#section-transits-structure)", "10-2": "[Flights Structure](#section-flights-structure)", "11-2": "[Religion Structure](#section-religion-structure)", "2-0": "ethnicity", "2-1": "The user's ethnic groups segmentation with probability scores.", "2-2": "JSON Array of [Ethnicity Structure](#section-ethnicity-structure)" }, "cols": 3, "rows": 12 } [/block] ##Gender Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "gender", "0-1": "User’s estimated gender: Male or Female", "0-2": "String", "0-3": "male", "1-0": "confidence", "1-1": "“gender” confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "1-2": "String", "1-3": "high" }, "cols": 4, "rows": 2 } [/block] ##Age Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "min", "1-0": "max", "2-0": "confidence", "2-1": "“age” confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "1-1": "User’s estimated maximal age group.", "0-1": "User’s estimated minimal age group.", "0-2": "Int", "1-2": "Int", "2-2": "String", "2-3": "high", "1-3": "32", "0-3": "25" }, "cols": 4, "rows": 3 } [/block] ##Ethnicity Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "name", "0-1": "The ethnic group name. Currently supported: White, Black, Asian and Latino.", "1-0": "probability", "1-1": "The ethnic group's probability score. Ranges from 0 to 100.", "0-3": "Latino", "0-2": "String", "1-2": "Int", "1-3": "77" }, "cols": 4, "rows": 2 } [/block] ##Home Structure *[Back to top](#response)* [block:parameters] { "data": { "0-0": "place", "1-0": "is_primary", "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "1-3": "True", "1-2": "Boolean", "1-1": "In case of multiple home address, this parameter is used to distinct between the primary and the secondaries.", "0-1": "Home location details and statistic data.", "0-2": "[Place](doc:place) Structure" }, "cols": 4, "rows": 2 } [/block] ##Work Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-3": "Banker", "0-2": "String", "0-1": "User’s occupation description. For example:\n * Driver / Delivery / Field service\n * Housewife\n * Unemployed / Works from home\n * High School Student\n * Law School Student\n * Medical School Student\n * College\n * University\n * Other", "0-0": "occupation", "1-0": "job_type", "1-1": "Can be one of the following:\n * full_time_job\n * part_time_job", "1-2": "String", "1-3": "full_time_job", "2-0": "place", "2-1": "Workplace location detail, venue information and statistic data.", "2-2": "[Place](doc:place) Structure", "3-0": "work_days", "4-0": "weekly_work_hours", "5-0": "is_primary", "3-1": "A 7 cells length array with boolean values to mark the working days.\n\nFirst cell is equivalent to Monday.", "4-1": "Estimated number of working hours per week", "5-1": "In case of multiple occupations, this parameter is used to distinct between the primary and the secondaries.", "5-2": "Boolean", "5-3": "true", "4-2": "Int", "4-3": "44", "3-2": "Array[7]", "3-3": "[true, true, true, true, true, false, false] - Work days are from Monday to Friday" }, "cols": 4, "rows": 6 } [/block] ##Household Income Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "min", "1-0": "max", "2-0": "confidence", "2-1": "“household_income” confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "1-1": "The user’s estimated maximum annual household income in USD.", "0-1": "The user’s estimated minimum annual household income in USD.", "0-2": "Int", "1-2": "Int", "2-2": "String", "2-3": "high", "1-3": "125000", "0-3": "100000" }, "cols": 4, "rows": 3 } [/block] ##Interests Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "1-0": "confidence", "1-1": "This interest confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "1-2": "String", "1-3": "high", "0-1": "A user’s interest. The following is the list of Placer’s top interests:\n * Athletics & Sports\n * Cafés\n * Children Entertainment\n * Cosmetics\n * Dining\n * Fine Arts\n * Fitness\n * Gambling\n * Grocery Shopping\n * Live Music\n * Live Sports\n * Movies\n * Nightlife\n * Pets\n * QSR\n * Shopping\n * Ski", "0-2": "String", "0-3": "”Live Sports”", "0-0": "interest" }, "cols": 4, "rows": 2 } [/block] ##In-the-Market Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "product", "1-0": "confidence", "1-1": "This product purchase intent confidence level. Can be of the following: “high”, ”medium” or ”low”.", "1-2": "String", "1-3": "high", "0-3": "“Car Insurance”", "0-2": "String", "0-1": "A tangible product or service the user is interested in. For example:\n * Car\n * Car Insurance\n * Travel\n * Kids Toys\n * Appliances\n * Dating Services" }, "cols": 4, "rows": 2 } [/block] ##Personas Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "persona", "1-0": "confidence", "0-1": "A persona that matches the user. \nFor example:\n * Mom\n * New Mom\n * Soccer Mom\n * Single\n * High Net-Worth Individual\n * Health & Fitness Enthusiasts\n * Fashionistas\n * Business Traveler\n * Leisure Traveler\n * Bookworm\n * Engineering Enthusiasts", "0-2": "String", "0-3": "“Soccer Mom”", "1-1": "This persona confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "1-2": "String", "1-3": "high" }, "cols": 4, "rows": 2 } [/block] ##Transits Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "avg_kms_per_day", "1-0": "main_transportation", "2-0": "degree", "2-1": "Number between 0 to 10 which represents the user’s traveled KM statistic decile compared to all of Placer’s users.", "1-1": "Can be one of the following:\n * Car or taxi\n * Bus\n * Train", "1-2": "string", "0-2": "float", "0-3": "35.1", "1-3": "Bus", "2-2": "int", "2-3": "9" }, "cols": 4, "rows": 3 } [/block] ##Flights Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "yearly_count", "1-0": "degree", "2-0": "confidence", "2-1": "“yearly_count” confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "2-2": "string", "2-3": "high", "1-1": "Number between 0 to 10 that represents the user’s flights per year statistic decile compared to all of Placer’s users.", "0-1": "Estimated number of flights per year.", "0-2": "int", "1-2": "int", "0-3": "4", "1-3": "9" }, "cols": 4, "rows": 3 } [/block] ##Religion Structure *[Back to top](#response)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "religion", "1-0": "confidence", "1-1": "“religion” confidence level. Can be one of the following: “high”, ”medium” or ”low”.", "0-1": "The user’s religion: Christian, Jewish, Muslim, etc.", "0-2": "string", "1-2": "string", "0-3": "Christian", "1-3": "high" }, "cols": 4, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Example" } [/block] [block:code] { "codes": [ { "code": "{\n \"total_count\": 1,\n \"error_code\": 0,\n \"data\": [\n {\n \"insights\": {\n \"interests\": [\n {\n \"confidence\": \"high\",\n \"interest\": \"Travel\"\n },\n {\n \"confidence\": \"high\",\n \"interest\": \"Higher Education\"\n },\n {\n \"confidence\": \"high\",\n \"interest\": \"Café\"\n },\n {\n \"confidence\": \"low\",\n \"interest\": \"Grocery Shopping\"\n },\n {\n \"confidence\": \"low\",\n \"interest\": \"Dining\"\n },\n {\n \"confidence\": \"low\",\n \"interest\": \"Ski\"\n },\n {\n \"confidence\": \"low\",\n \"interest\": \"Arts & Crafts\"\n }\n ],\n \"work\": [\n {\n \"weekly_work_hours\": 5,\n \"is_primary\": true,\n \"job_type\": \"Part time job\",\n \"work_days\": [\n true,\n true,\n true,\n true,\n true,\n false,\n false\n ],\n \"place\": {\n \"estimated_address\": {\n \"city\": \"Escondido Village\",\n \"country\": \"United States\",\n \"state\": \"CA\",\n \"formatted_city\": \"Escondido Village, CA, United States\",\n \"postal_code\": \"94305.0\",\n \"formatted_address\": \"340 Olmsted Road, Escondido Village, CA, United States\",\n \"street_address\": \"340 Olmsted Road\"\n },\n \"estimated_geolocation\": {\n \"lat\": 37.42533289095223,\n \"long\": -122.15375128758956,\n \"accuracy\": 8.625326029288335\n },\n \"venue_info\": {\n \"category\": \"Stadium\",\n \"geolocation\": {\n \"lat\": 37.426074392968005,\n \"long\": -122.15462213417152\n },\n \"venue_id\": \"4ea335bb722ec75adea438d8\",\n \"name\": \"Washington Warmup-Stanford\",\n \"probability\": 0.5803318477173641,\n \"venue_provider\": \"Foursquare\",\n \"sub_category\": \"Stadium\"\n },\n \"first_visit_time\": \"2015-11-04T22:52:57.238Z\",\n \"last_visit_time\": \"2015-12-30T18:21:47.571Z\",\n \"type\": \"Work\",\n \"id\": \"563aa0b46f868794271bd56e\"\n },\n \"occupation\": \"Other\"\n }\n ],\n \"flights\": {\n \"yearly_count\": 2\n },\n \"household_income\": {\n \"max\": 75000,\n \"confidence\": \"low\",\n \"min\": 60000\n },\n \"brands\": [\n {\n \"confidence\": \"high\",\n \"place_ids\": [\n \"56412b8f6f86b9dfb5ef8d88\",\n \"5644e4f16f8632e528976025\",\n \"564a58c5e4b059280e3b0a4e\"\n ],\n \"type\": \"food\",\n \"name\": \"Starbucks\"\n }\n ],\n \"home\": [\n {\n \"is_primary\": true,\n \"place\": {\n \"estimated_address\": {\n \"city\": \"Escondido Village\",\n \"country\": \"United States\",\n \"state\": \"CA\",\n \"formatted_city\": \"Escondido Village, CA, United States\",\n \"postal_code\": \"94305.0\",\n \"formatted_address\": \"103 Hoskins Court, Escondido Village, CA, United States\",\n \"street_address\": \"103 Hoskins Court\"\n },\n \"estimated_geolocation\": {\n \"lat\": 37.42642624277531,\n \"long\": -122.15600842597217,\n \"accuracy\": 4.883181473508882\n },\n \"first_visit_time\": \"2015-11-05T00:05:14.244Z\",\n \"last_visit_time\": \"2016-01-06T03:01:14.644Z\",\n \"type\": \"Home\",\n \"id\": \"563aa0b46f868794271bd56f\"\n }\n }\n ],\n \"transits\": {\n \"avg_kms_per_day\": 11.326217651367188\n },\n \"ethnicity\": [\n {\n \"ethnicity\": \"White\",\n \"probability\": 48\n },\n {\n \"ethnicity\": \"Asian\",\n \"probability\": 26\n },\n {\n \"ethnicity\": \"Latino\",\n \"probability\": 14\n },\n {\n \"ethnicity\": \"Black\",\n \"probability\": 5\n }\n ]\n },\n \"device_id\": \"563a96eafdef261ed41d43e9\"\n }\n ],\n \"result\": \"SUCCESS\"\n}", "language": "json" } ] } [/block]