v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB

Interactions

Capture User Feedback and Ratings

Record user feedback and ratings for conversations or individual messages.

Use this endpoint to collect feedback about response quality or overall conversation experiences. You can rate either a specific message (using messageId or externalMessageId) or an entire conversation (using conversationId or externalConversationId).

post/ratings

Request body

productIdstring uuid required

The Greenflash product ID to rate.

conversationIdstring uuid

The Greenflash conversation ID to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.

externalConversationIdstring

Your external conversation identifier to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.

messageIdstring

The Greenflash message ID to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.

externalMessageIdstring

Your external message identifier to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.

ratingnumber required

The rating value. Must be between ratingMin and ratingMax (inclusive).

ratingMinnumber required

The minimum possible rating value (e.g., 1 for a 1-5 scale).

ratingMaxnumber required

The maximum possible rating value (e.g., 5 for a 1-5 scale).

ratedAtstring date

When the rating was given. Defaults to current time if not provided.

feedbackstring

Optional text feedback accompanying the rating.

Response

Rating logged successfully

successboolean required

Whether the API call was successful.