{"_id":"59e70b9fe027ae002e7d2f10","category":{"_id":"59e70b9ee027ae002e7d2eda","version":"59e70b9ee027ae002e7d2ed2","project":"5496d393f52a630b00519cdd","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-12-21T18:49:06.424Z","from_sync":false,"order":8,"slug":"structures","title":"Structures"},"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-22T09:55:32.176Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Example\",\n    \"1-0\": \"type\",\n    \"2-0\": \"type_id\",\n    \"3-0\": \"first_visit_time\",\n    \"4-0\": \"last_visit_time\",\n    \"5-0\": \"significance\",\n    \"6-0\": \"estimated_geolocation\",\n    \"7-0\": \"estimated_address\",\n    \"8-0\": \"venue_info\",\n    \"12-0\": \"statistics\\n*(optional)*\",\n    \"12-1\": \"General statistics about the user’s visits and time spent. **Returned only if specified in query parameters.**\",\n    \"8-1\": \"The related venue info.\",\n    \"7-1\": \"The estimated address of the place\",\n    \"6-1\": \"The place’s raw coordinates, based on digestion of the location data gathered from the user\",\n    \"5-1\": \"The place’s significance rank\",\n    \"4-1\": \"Time and date of the last visit in this place\",\n    \"3-1\": \"Time and date of the first visit in this place\",\n    \"2-1\": \"See [Places Types](doc:places-types) table for list of potential values\",\n    \"1-1\": \"See [Places Types](doc:places-types) table for list of potential values\",\n    \"1-2\": \"string\",\n    \"2-2\": \"int\",\n    \"3-2\": \"UTC date/time\",\n    \"4-2\": \"UTC date/time\",\n    \"3-3\": \"2013-11-02T08:27:30.189Z\",\n    \"2-3\": \"2\",\n    \"4-3\": \"2014-02-02T09:47:30.189Z\",\n    \"1-3\": \"Work\",\n    \"5-2\": \"int\",\n    \"5-3\": \"45\",\n    \"6-2\": \"[Geolocation Structure](doc:geolocation-structure)\",\n    \"7-2\": \"[Address Structure](doc:address)\",\n    \"8-2\": \"[Venue Structure](doc:venue)\",\n    \"12-2\": \"[Statistics \\nStructure](#section-statistics-structure)\",\n    \"11-0\": \"visits\\n*(optional)*\",\n    \"11-1\": \"Contains the list of place visits during the query time frame. **Returned only if specified in query parameters.**\",\n    \"11-2\": \"JSON array\\nof [Visit](doc:visit)\",\n    \"0-0\": \"id\",\n    \"0-1\": \"The place ID. Notice - place ID is unique per user.\",\n    \"0-2\": \"string\",\n    \"0-3\": \"53c80eac1b963300023e52c2\",\n    \"9-0\": \"enclosing_venues\",\n    \"9-1\": \"If available, the details of the enclosing venues. For example, a store in a mall will have an \\\"enclosing_venues\\\" of the mall info.\",\n    \"9-2\": \"JSON array of\\n[Venue Structure](doc:venue)\",\n    \"9-3\": \"\",\n    \"13-0\": \"visit_confirmation_count\",\n    \"13-1\": \"Total sum of visit confirmations\",\n    \"13-2\": \"int\",\n    \"13-3\": \"12\",\n    \"10-0\": \"venues\\n*(optional)*\",\n    \"10-1\": \"Used to retrieve the full list of venues that were associated with the visit place. The list is sorted from the highest venue probability score to the lowest.\\n**Returned only if specified in query parameters.**\",\n    \"10-2\": \"JSON array of\\n[Venue Structure](doc:venue)\"\n  },\n  \"cols\": 4,\n  \"rows\": 14\n}\n[/block]\n##Statistics Structure\n*[Back to top](#)* \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\": \"visit_count\",\n    \"1-0\": \"total_visits_time\",\n    \"2-0\": \"avg_visit_time\",\n    \"3-0\": \"at_place_precentage\",\n    \"3-1\": \"Percentage of time, out of total time since beginning of data collection, spent in the place.\",\n    \"2-1\": \"The average time spent in each visit (in minutes), in respect with the time range.\",\n    \"1-1\": \"Total sum of minutes spent in the place, in respect with the time range.\",\n    \"0-1\": \"The number of times the user visited the place, in respect with the time range.\",\n    \"0-2\": \"int\",\n    \"1-2\": \"int\",\n    \"2-2\": \"int\",\n    \"3-2\": \"double\",\n    \"3-3\": \"0.14 (=14%)\",\n    \"2-3\": \"49\",\n    \"1-3\": \"249\",\n    \"0-3\": \"5\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\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  \\\"estimated_address\\\": {\\n    \\\"city\\\": \\\"Santa Cruz\\\", \\n    \\\"country\\\": \\\"United States\\\", \\n    \\\"formatted_address\\\": \\\"Walnut Avenue, Santa Cruz, California, United States\\\", \\n    \\\"formatted_city\\\": \\\"Santa Cruz, California, United States\\\", \\n    \\\"postal_code\\\": \\\"95060.0\\\", \\n    \\\"state\\\": \\\"California\\\", \\n    \\\"street_address\\\": \\\"Walnut Avenue\\\"\\n  }, \\n  \\\"estimated_geolocation\\\": {\\n    \\\"accuracy\\\": 8.72183669876564, \\n    \\\"lat\\\": 36.9726328394542, \\n    \\\"long\\\": -122.02771345617225\\n  }, \\n  \\\"first_visit_time\\\": \\\"2016-10-05T02:20:05.870Z\\\", \\n  \\\"id\\\": \\\"57b515dee4b0a41345fc89fe\\\", \\n  \\\"last_visit_time\\\": \\\"2016-10-05T04:01:24.688Z\\\", \\n  \\\"significance\\\": 0, \\n  \\\"statistics\\\": {\\n    \\\"at_place_percentage\\\": 0.0, \\n    \\\"avg_visit_time\\\": 101, \\n    \\\"total_visits_time\\\": 101, \\n    \\\"visit_count\\\": 1\\n  }, \\n  \\\"type\\\": \\\"Movie Theater\\\", \\n  \\\"type_id\\\": 5, \\n  \\\"venue_info\\\": {\\n    \\\"category\\\": \\\"Movie Theater\\\", \\n    \\\"name\\\": \\\"The Nick\\\", \\n    \\\"probability\\\": 0.984193510430788, \\n    \\\"sub_category\\\": \\\"Movie Theater\\\"\\n  }, \\n  \\\"visits\\\": [\\n    {\\n      \\\"end_time\\\": \\\"2016-08-17T21:10:53.930-07:00\\\", \\n      \\\"event_type\\\": \\\"visit\\\", \\n      \\\"id\\\": \\\"57b515ddfdef2628122f544d\\\", \\n      \\\"is_confirmed\\\": false, \\n      \\\"is_ongoing\\\": false, \\n      \\\"place_id\\\": \\\"57b515dee4b0a41345fc89fe\\\", \\n      \\\"start_time\\\": \\\"2016-08-17T18:39:01.010-07:00\\\"\\n    }, \\n    {\\n      \\\"end_time\\\": \\\"2016-08-20T21:12:06.504-07:00\\\", \\n      \\\"event_type\\\": \\\"visit\\\", \\n      \\\"id\\\": \\\"57b9281cfdef2610232f5441\\\", \\n      \\\"is_confirmed\\\": false, \\n      \\\"is_ongoing\\\": false, \\n      \\\"place_id\\\": \\\"57b515dee4b0a41345fc89fe\\\", \\n      \\\"start_time\\\": \\\"2016-08-20T18:51:11.251-07:00\\\"\\n    }, \\n    {\\n      \\\"end_time\\\": \\\"2016-08-21T20:47:10.184-07:00\\\", \\n      \\\"event_type\\\": \\\"visit\\\", \\n      \\\"id\\\": \\\"57ba8654fdef266117a3b95d\\\", \\n      \\\"is_confirmed\\\": false, \\n      \\\"is_ongoing\\\": false, \\n      \\\"place_id\\\": \\\"57b515dee4b0a41345fc89fe\\\", \\n      \\\"start_time\\\": \\\"2016-08-21T18:47:02.537-07:00\\\"\\n    }, \\n    {\\n      \\\"end_time\\\": \\\"2016-10-04T21:01:24.688-07:00\\\", \\n      \\\"event_type\\\": \\\"visit\\\", \\n      \\\"id\\\": \\\"57f47f7cfdef265b80e66f57\\\", \\n      \\\"is_confirmed\\\": false, \\n      \\\"is_ongoing\\\": false, \\n      \\\"place_id\\\": \\\"57b515dee4b0a41345fc89fe\\\", \\n      \\\"start_time\\\": \\\"2016-10-04T19:20:05.870-07:00\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"place","type":"basic","title":"Place"}
[block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "1-0": "type", "2-0": "type_id", "3-0": "first_visit_time", "4-0": "last_visit_time", "5-0": "significance", "6-0": "estimated_geolocation", "7-0": "estimated_address", "8-0": "venue_info", "12-0": "statistics\n*(optional)*", "12-1": "General statistics about the user’s visits and time spent. **Returned only if specified in query parameters.**", "8-1": "The related venue info.", "7-1": "The estimated address of the place", "6-1": "The place’s raw coordinates, based on digestion of the location data gathered from the user", "5-1": "The place’s significance rank", "4-1": "Time and date of the last visit in this place", "3-1": "Time and date of the first visit in this place", "2-1": "See [Places Types](doc:places-types) table for list of potential values", "1-1": "See [Places Types](doc:places-types) table for list of potential values", "1-2": "string", "2-2": "int", "3-2": "UTC date/time", "4-2": "UTC date/time", "3-3": "2013-11-02T08:27:30.189Z", "2-3": "2", "4-3": "2014-02-02T09:47:30.189Z", "1-3": "Work", "5-2": "int", "5-3": "45", "6-2": "[Geolocation Structure](doc:geolocation-structure)", "7-2": "[Address Structure](doc:address)", "8-2": "[Venue Structure](doc:venue)", "12-2": "[Statistics \nStructure](#section-statistics-structure)", "11-0": "visits\n*(optional)*", "11-1": "Contains the list of place visits during the query time frame. **Returned only if specified in query parameters.**", "11-2": "JSON array\nof [Visit](doc:visit)", "0-0": "id", "0-1": "The place ID. Notice - place ID is unique per user.", "0-2": "string", "0-3": "53c80eac1b963300023e52c2", "9-0": "enclosing_venues", "9-1": "If available, the details of the enclosing venues. For example, a store in a mall will have an \"enclosing_venues\" of the mall info.", "9-2": "JSON array of\n[Venue Structure](doc:venue)", "9-3": "", "13-0": "visit_confirmation_count", "13-1": "Total sum of visit confirmations", "13-2": "int", "13-3": "12", "10-0": "venues\n*(optional)*", "10-1": "Used to retrieve the full list of venues that were associated with the visit place. The list is sorted from the highest venue probability score to the lowest.\n**Returned only if specified in query parameters.**", "10-2": "JSON array of\n[Venue Structure](doc:venue)" }, "cols": 4, "rows": 14 } [/block] ##Statistics Structure *[Back to top](#)* [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Example", "0-0": "visit_count", "1-0": "total_visits_time", "2-0": "avg_visit_time", "3-0": "at_place_precentage", "3-1": "Percentage of time, out of total time since beginning of data collection, spent in the place.", "2-1": "The average time spent in each visit (in minutes), in respect with the time range.", "1-1": "Total sum of minutes spent in the place, in respect with the time range.", "0-1": "The number of times the user visited the place, in respect with the time range.", "0-2": "int", "1-2": "int", "2-2": "int", "3-2": "double", "3-3": "0.14 (=14%)", "2-3": "49", "1-3": "249", "0-3": "5" }, "cols": 4, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Example" } [/block] [block:code] { "codes": [ { "code": "{\n \"estimated_address\": {\n \"city\": \"Santa Cruz\", \n \"country\": \"United States\", \n \"formatted_address\": \"Walnut Avenue, Santa Cruz, California, United States\", \n \"formatted_city\": \"Santa Cruz, California, United States\", \n \"postal_code\": \"95060.0\", \n \"state\": \"California\", \n \"street_address\": \"Walnut Avenue\"\n }, \n \"estimated_geolocation\": {\n \"accuracy\": 8.72183669876564, \n \"lat\": 36.9726328394542, \n \"long\": -122.02771345617225\n }, \n \"first_visit_time\": \"2016-10-05T02:20:05.870Z\", \n \"id\": \"57b515dee4b0a41345fc89fe\", \n \"last_visit_time\": \"2016-10-05T04:01:24.688Z\", \n \"significance\": 0, \n \"statistics\": {\n \"at_place_percentage\": 0.0, \n \"avg_visit_time\": 101, \n \"total_visits_time\": 101, \n \"visit_count\": 1\n }, \n \"type\": \"Movie Theater\", \n \"type_id\": 5, \n \"venue_info\": {\n \"category\": \"Movie Theater\", \n \"name\": \"The Nick\", \n \"probability\": 0.984193510430788, \n \"sub_category\": \"Movie Theater\"\n }, \n \"visits\": [\n {\n \"end_time\": \"2016-08-17T21:10:53.930-07:00\", \n \"event_type\": \"visit\", \n \"id\": \"57b515ddfdef2628122f544d\", \n \"is_confirmed\": false, \n \"is_ongoing\": false, \n \"place_id\": \"57b515dee4b0a41345fc89fe\", \n \"start_time\": \"2016-08-17T18:39:01.010-07:00\"\n }, \n {\n \"end_time\": \"2016-08-20T21:12:06.504-07:00\", \n \"event_type\": \"visit\", \n \"id\": \"57b9281cfdef2610232f5441\", \n \"is_confirmed\": false, \n \"is_ongoing\": false, \n \"place_id\": \"57b515dee4b0a41345fc89fe\", \n \"start_time\": \"2016-08-20T18:51:11.251-07:00\"\n }, \n {\n \"end_time\": \"2016-08-21T20:47:10.184-07:00\", \n \"event_type\": \"visit\", \n \"id\": \"57ba8654fdef266117a3b95d\", \n \"is_confirmed\": false, \n \"is_ongoing\": false, \n \"place_id\": \"57b515dee4b0a41345fc89fe\", \n \"start_time\": \"2016-08-21T18:47:02.537-07:00\"\n }, \n {\n \"end_time\": \"2016-10-04T21:01:24.688-07:00\", \n \"event_type\": \"visit\", \n \"id\": \"57f47f7cfdef265b80e66f57\", \n \"is_confirmed\": false, \n \"is_ongoing\": false, \n \"place_id\": \"57b515dee4b0a41345fc89fe\", \n \"start_time\": \"2016-10-04T19:20:05.870-07:00\"\n }\n ]\n}", "language": "json" } ] } [/block]