Feedback Sessions API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Collect client feedback on a site before handover

You've finished building a site for a client and want them to review it before it goes live. You give them a link that stays open for the review period, then work through what they left.

To collect client feedback on a site:

1. Call Create Feedback Session with an expirationDate at the end of the review period, and fields set to SHARE_URL:

   Copy

2. Send the returned shareUrl to the client. They review the site and leave comments through it.

3. Call Query Comments, filtering on feedbackId with the feedback session's id, to retrieve the comments left through the session.

4. Triage and reply to each comment with the Comments API.

List the review links still collecting feedback

A site can have several feedback sessions open at once, for example one per stakeholder. You want to show the ones that still accept comments, with a link to each, so a teammate can resend a link or see what's open.

To list the review links still collecting feedback:

1. Call Query Feedback Sessions, filtering on expirationDate later than now, and with fields set to SHARE_URL:

   Copy

2. Page through the results with the cursors.next value returned in pagingMetadata, and display each session's shareUrl and expirationDate.

Clean up expired feedback sessions

Old review rounds pile up on a site you keep iterating on. You want to remove the feedback sessions that no longer accept comments, while keeping the comments left through them.

To clean up expired feedback sessions:

1. Call Query Feedback Sessions, filtering on expirationDate earlier than now.
2. Page through the results with the cursors.next value returned in pagingMetadata, collecting every session's id.
3. Call Delete Feedback Session for each collected session. The comments left through it remain, and you can still retrieve them with Query Comments.