This API retrieves information about the current comment being written and a prefix of the user name to search, and returns a list of suggested users for auto-complete.
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
|||categoryID||string||The identifier of the current comments category.|
|||streamID||string||The identifier of the current comments stream.|
|||parentCommentID||string||The identifier of the parent of the comment that is being written. If the current comment is not a reply, the value is null.|
|||limit||integer||The maximum number of users to retrieve. The default value is 10. The maximum possible value to set is 25.|
|||usernamePrefix||string||A prefix of the user name to search.|
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.
|relatedUsers||Array of objects||An array containing the suggested users for auto-complete. Each object includes the following fields:|
A field that does not contain data will not appear in the response.