This API retrieves the comments made by a specific user.
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.
|||senderUID||string||The unique ID of the user whose comments are to be retrieved. See User.UID for more information.|
|||categoryID||string||The identifier of the comments category by which to filter the retrieved comments. This parameter is required if using streamID.|
The identifier of the comments stream by which to filter the retrieved comments.
* If using a streamID you must also supply a categoryID, otherwise it will be ignored.
|||includeNote||Boolean||Indicates whether to add the note custom object to the response.|
|||includeReplies||Boolean||Indicates whether to include comment replies in the response.|
|||includeStreamInfo||Boolean||This parameter specifies whether to include a stream information object in the response. The default is 'false '. When set to 'true' the response to the method will include the StreamInfo object.|
|||includeUID||Boolean||Indicates whether the UID of the commenter will be included in the returned object per comment. The default value is 'false'.|
|||limit||integer||The maximum number of comments to retrieve. The default value is 10.|
|||sort||string||The comments may be sorted in one of the following orders:|
|||start||string||Defines what should be the starting point of the comments to retrieve. The purpose of this parameter is pagination of the comments. Use the limit parameter to define how many comments per page. For the first page don't set the start parameter. The response includes a next field, which is a pointer to the starting point of the next page. Set the start parameter with the value of the next field received in the response of the previous getUserComments request.|
|||tag||string||The tag by which to filter the retrieved comments.|
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.
An array listing the comments. Each comment is represented by a JSON Comment object. In addition to the regular fields of the Comment object, the following fields are returned in the response of this method:
|commentCount||integer||The number of returned comments.|
|next||string||A pointer to the starting point of the next comments page. The purpose of this field is pagination of the comments. Use this field as the value of the 'start' parameter of the next getUserComments request, thus retrieving the next comments and avoid retrieving the same comments again.|
|hasMore||Boolean||Specifies whether there are more comments that were not returned within this response.|
A field that does not contain data will not appear in the response.