Skip to content

Interface: ReviewSummary ​

Review summary returned by /reviews/{apiKey}/{reviewType}/review_summary and the related group/customer/filtered summary endpoints.

ai_summary, q_n_a_summary, and rating_breakdown are only present when the corresponding ai_summary=1 / q_n_a_summary=1 / rating_breakdown=1 query flags are passed.

Properties ​

ai_summary? ​

ts
optional ai_summary?: AIReviewSummary;

average_ratings? ​

ts
optional average_ratings?: number;

q_n_a_summary? ​

ts
optional q_n_a_summary?: QnaReviewSummaryItem[];

rating_breakdown? ​

ts
optional rating_breakdown?: RatingBreakdown;

total_reviews? ​

ts
optional total_reviews?: number;