Back to reference

SessionSuggestionBreakdown

Suggestion total along with counts by type. Try it nowopen in new window.

Within SessionStats, used by both suggestionsAccepted and suggestionsSent.

interface SessionSuggestionBreakdown {
  clarity: number;
  correctness: number;
  delivery: number;
  engagement: number;
  total: number;
}

Properties

clarityType: number

The total number of suggestions delivered for the Clarity category.

The Clarity category focuses on making every sentence concise and easy to follow, and rewriting hard-to-read sentences.

correctnessType: number

The total number of suggestions delivered for the Correctness category.

The Correctness category focuses on eliminating grammar, spelling, and punctuation mistakes, and ensuring word choices sound natural and fluent.

deliveryType: number

The total number of suggestions delivered for the Delivery category.

The Delivery category focuses on helping end users find the right tone, eliminating hedging language (to sound more confident), and finessing phrases to have more tact and empathy for readers, and supporting respectful and current language practices.

engagementType: number

The total number of suggestions delivered for the Engagement category.

The Engagement category focuses on choosing the most compelling words, and using varied, engaging sentence structure.

totalType: number

The total number of suggestions delivered to your users across all the editors in your application.

Last Updated: 1/30/2023, 10:49:17 PM