Skip to main content

Sentiment order

Purpose of sentiment_order​

The sentiment_order field is designed to control the display order of sentiment-based answers in a survey, aligning with the CSAT2 and CSAT3 scales. This helps survey administrators and analysts present data in a way that is both intuitive and aligned with the analytical objectives, making the results easier to understand and interpret.

How sentiment_order Works​

The sentiment_order field affects the arrangement of answer options based on their sentiment scores—essentially how positive or negative the sentiment is perceived.

Field: sentiment_order​

  • Type: String
  • Nullable: Yes
  • Allowed Values: asc, desc
  • Default Value: desc for CSAT2 and CSAT3 scale questions otherwise null

Ascending Order (asc)​

  • Description: Answers are sorted by sentiment score from the lowest (most negative) to the highest (most positive).
  • Use Case: Useful for visualizing improvement areas or emphasizing negative feedback in results presentations.
  • Example:
    • Bad (Score: 1)
    • Neutral (Score: 2)
    • Good (Score: 3)

Descending Order (desc)​

  • Description: Answers are sorted by sentiment score from the highest (most positive) to the lowest (most negative).
  • Use Case: Ideal for highlighting positive feedback or showcasing top strengths in survey reports.
  • Example:
    • Good (Score: 3)
    • Neutral (Score: 2)
    • Bad (Score: 1)

Endpoint​