A feedback session scopes a round of review on a site and carries an expiration date. Once a
session lapses it accepts no new comments, but the comments already in it stay readable and can
still be triaged and replied to.
idstringRead-onlyformat GUID
Comment ID.
messagestringminLength 2maxLength 2000
Text of the comment.
repliesArray <CommentReply>Read-onlymaxItems 1000
Replies to the comment, ordered oldest first.
A reply is addressed by its index in this list, so indexes shift when an earlier reply is
deleted. Pass the comment's current revision when updating or deleting a reply to be sure the
index you're addressing is still the one you read.
revisionstringRead-onlyformat int64
Revision number, which increments by 1 each time the comment is updated.
To prevent conflicting changes,
the current revision must be passed when updating the comment.
statusstringRead-only
Triage status of the comment.
Every comment starts as NEW.
Update Comment Status
is the only way for the site owner to change it, and a commenter can't set the status of their own
comment. A comment does return to NEW on its own when the commenter replies to it, whatever it
was triaged as; a reply from anyone else leaves the status alone. The commenter can also reopen a RESOLVED comment, which returns it to NEW.
Comment Object
A comment is a note left on a specific point of a site page as part of a feedback session.
Reviewers leave comments while reviewing a site. The site owner reads them, triages them by
status, replies to them, and deletes them.The reviewer who left the comment, as they introduced themselves.
Returned only when
fieldsincludesCOMMENTER.ID of the reviewer who left the comment. To retrieve the reviewer's name and email, specify
COMMENTERinfields.Where on the page the comment is anchored.
Date and time the comment was created.
ID of the feedback session the comment belongs to.
A feedback session scopes a round of review on a site and carries an expiration date. Once a session lapses it accepts no new comments, but the comments already in it stay readable and can still be triaged and replied to.
Comment ID.
Text of the comment.
Replies to the comment, ordered oldest first.
A reply is addressed by its index in this list, so indexes shift when an earlier reply is deleted. Pass the comment's current
revisionwhen updating or deleting a reply to be sure the index you're addressing is still the one you read.Revision number, which increments by 1 each time the comment is updated. To prevent conflicting changes, the current revision must be passed when updating the comment.
Triage status of the comment.
Every comment starts as
NEW. Update Comment Status is the only way for the site owner to change it, and a commenter can't set the status of their own comment. A comment does return toNEWon its own when the commenter replies to it, whatever it was triaged as; a reply from anyone else leaves the status alone. The commenter can also reopen aRESOLVEDcomment, which returns it toNEW.Date and time the comment was updated.