{"__v":0,"_id":"5480faa8ea7fd40b00cd7c22","category":{"__v":56,"_id":"546b909462515a14007ebc43","pages":["546fdf54a179880800187e8b","54738e24007eb108007e03ff","54738e7d1a20c70800e189b0","54738e8a007eb108007e0404","54738e9b1a20c70800e189b2","54738ec0007eb108007e0407","54738ed21a20c70800e189b5","54738ee2007eb108007e0414","54738f05007eb108007e0416","54738f23007eb108007e0418","54738f31007eb108007e041a","547f80f9b7c1e40800dcf46f","547f9758b7c1e40800dcf4c2","547f9a3f3031bc0800e5fec4","547fa5f63031bc0800e5fef3","547fa632b7c1e40800dcf4e9","547fa696b7c1e40800dcf4ec","547fa6cc3031bc0800e5fef6","547fab89b7c1e40800dcf511","547facedb7c1e40800dcf51f","547faeef3031bc0800e5ff2d","547fafb03031bc0800e5ff31","547fb05ab7c1e40800dcf52a","547fb07a3031bc0800e5ff38","547fb0c4b7c1e40800dcf531","547fb100b7c1e40800dcf535","547fb18c3031bc0800e5ff41","547fb2433031bc0800e5ff44","547fb2feb7c1e40800dcf539","547fb335b7c1e40800dcf53b","547fb4aa3031bc0800e5ff49","547fb4f4b7c1e40800dcf541","547fb553b7c1e40800dcf544","54809ecd5f83dd0800c38fd3","54809f715f83dd0800c38fd6","54809fa8a3e4ea22000976b7","54809fd3a3e4ea22000976ba","5480a00ba3e4ea22000976bc","5480f44dea7fd40b00cd7c06","5480f4fb0e664d0b00be35f9","5480f5a5ea7fd40b00cd7c0b","5480f607ea7fd40b00cd7c10","5480f657ea7fd40b00cd7c12","5480f69a0e664d0b00be35ff","5480f77aea7fd40b00cd7c14","5480f7e7ea7fd40b00cd7c18","5480f83dea7fd40b00cd7c1b","5480f950ea7fd40b00cd7c1e","5480f9a6ab84321d00eaf538","5480faa8ea7fd40b00cd7c22","5480fb0aea7fd40b00cd7c25","5480fbd8ea7fd40b00cd7c27","5480fc64ab84321d00eaf53c","54c01ec89290010d00934956","55581594e54fe019002a4f2c","556e8b29fc3aa80d00e1a953"],"project":"545137a814af501a00b50cf9","version":"545137a814af501a00b50cfc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-18T18:31:48.943Z","from_sync":false,"order":6,"slug":"rest-api","title":"REST API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"545137a814af501a00b50cf9","user":"5433099f9a2b451a00ad4531","version":{"__v":11,"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z","categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-05T00:22:00.909Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"try":true,"auth":"required","params":[{"_id":"5480faa8ea7fd40b00cd7c24","ref":"","in":"body","required":false,"desc":"A string for matching against the searchable fields in the specified models. For example, specifying the parameter prefix=ab would return autocomplete results for models that have searchable fields that begin with “ab”.  BOTH parameters are required. If either is missing, a 400 – Bad Request is returned.","default":"","type":"file","name":"prefix=string"},{"_id":"5480faa8ea7fd40b00cd7c23","ref":"","in":"body","required":false,"desc":"Accepts a comma separated list of the models that should be searched on and the how many results should be returned for each model. This is specified in the format modelName1:count1,modelName2:count2 where count is an integer and modelName can be the following.  BOTH parameters are required. If either is missing, a 400 – Bad Request is returned.","default":"","type":"mixed","name":"models=modelName:count"}],"url":"/autocomplete/ranked"},"isReference":false,"order":41,"body":"Return typeahead suggestions for the prefix passed\n\n“Accept: application/json” must be included as a header in the request.\n\nThe autocomplete feature is useful for giving suggestions to users when they begin to type something that looks like the name of a group, user or topic. This is most useful in composing messages in your app. If your user begins to type Hello, :::at:::kg and pauses for a fraction of a second, you can send the string kg and prompt the user with the username kgale to complete what she is typing.\n\nTo avoid excessive network activity, and to ensure you don’t run up against our rate limits, please only send requests after users have paused their typing for half a second, not when they’re continuously typing.  In addition, the autocomplete feature only accepts a max of 5 words per search.\n\nPlease also cache the results you receive for a few minutes to optimize the user experience. Users will often begin to type a string, then backspace. You shouldn’t be sending the same autocomplete prefix multiple times while the user sends a single message.\n\n\n**Parameters:**\n\nprefix=string – A string for matching against the searchable fields in the specified models. For example, specifying the parameter prefix=ab would return autocomplete results for models that have searchable fields that begin with “ab”.\n\nmodels=modelName:count -  Accepts a comma separated list of the models that should be searched on and the how many results should be returned for each model. This is specified in the format modelName1:count1,modelName2:count2 where count is an integer and modelName can be the following:\n\nBoth parameters above are required. If either is missing, a 400 – Bad Request is returned.\n\n\n**modelName Types:**\n\nuser\n\ngroup\n\ntopic\n\nfile\n\npage (note)\n\nopen_graph_object\n\ndepartment\n\nexternal_network\n\ndomain\n\nFor example, specifying the parameter models=user:5,group:5,open_graph_object:5 would return autocomplete results just for users, groups, and open graph objects and return up to 5 of each.","excerpt":"","slug":"autocompleteranked","type":"basic","title":"/autocomplete/ranked"}