---
title: "GET /api/Review/summary"
method: GET
path: "/api/Review/summary"
tags: ["Reviews"]
---

# GET /api/Review/summary

`GET /api/Review/summary`

## Query parameters

- `siteId` string
- `itemId` string
- `rd` boolean

## Response `200`

OK

- GetRatingSummaryByItemResponse
  - `success` boolean
  - `message` string, nullable
  - `data` RatingSummaryByItemData
    - `itemId` string, nullable
    - `totalReviews` integer
    - `averageRating` number, float
    - `positiveCount` integer
    - `negativeCount` integer
    - `positiveText` string, nullable
    - `negativeText` string, nullable
    - `summarizedText` string, nullable
    - `rating1Count` integer
    - `rating2Count` integer
    - `rating3Count` integer
    - `rating4Count` integer
    - `rating5Count` integer
    - `createdDate` string, nullable
    - `customData` object, nullable
  - `badgeLabels` BadgeLabels
    - `basedOnLabel` string, nullable
    - `reviewButtonLabel` string, nullable
  - `addReviewLabels` AddReviewLabels
    - `writeReviewForText` string, nullable
    - `updateReviewForText` string, nullable
    - `reviewerNameLabel` string, nullable
    - `reviewerNamePlaceholder` string, nullable
    - `ratingLabel` string, nullable
    - `reviewInputPlaceholder` string, nullable
    - `termsCheckboxText` string, nullable
    - `requiredFieldMessage` string, nullable
    - `addBtnLabel` string, nullable
    - `updateBtnLabel` string, nullable
    - `submittingBtnLabel` string, nullable
    - `updatingBtnLabel` string, nullable
    - `successMsgOnAdd` string, nullable
    - `successMsgOnUpdate` string, nullable
    - `termsLinkLabel` string, nullable
    - `termsLinkUrl` string, nullable
    - `starRatingErrorMsg` string, nullable
    - `reviewTextErrorMsg` string, nullable
    - `guidelinesErrorMsg` string, nullable
    - `nameErrorMsg` string, nullable
    - `subHeaderText` string, nullable
    - `detractorsRatingText` string, nullable
    - `passivesRatingText` string, nullable
    - `promotersRatingText` string, nullable
  - `reviewLabels` ReviewLabels
    - `reviewerName` string, nullable
    - `sortOnLatest` string, nullable
    - `sortOnHighestGrade` string, nullable
    - `sortOnLowestRating` string, nullable
    - `sortOnMostLikes` string, nullable
    - `loadReviewBtnLabel` string, nullable
    - `translatedFromLabel` string, nullable
    - `todayTextlable` string, nullable
    - `yesterdayTextlable` string, nullable
    - `daysAgoTextlable` string, nullable
    - `monthsAgoTextlable` string, nullable
    - `yearsAgoTextlable` string, nullable
    - `commentPopupHeader` string, nullable
    - `loadCommentBtnLabel` string, nullable
    - `addCommentLabel` string, nullable
    - `commentInputPlaceholder` string, nullable
    - `addCommentBtnLabel` string, nullable
    - `updateCommentBtnLabel` string, nullable
    - `editCommentPopupHeader` string, nullable
    - `cancelCommentText` string, nullable
    - `commentAddSuccessMessage` string, nullable
    - `commentUpdateSuccessMessage` string, nullable
    - `noCommentsYetMessage` string, nullable
    - `commentRequiredMessage` string, nullable
    - `commentLoadingText` string, nullable
    - `verifiedCutsomerText` string, nullable
    - `showingStarReviewsLabel` string, nullable
    - `seeAllReviewsLabel` string, nullable
    - `allReviewsLabel` string, nullable
  - `addReviewButtonLabels` AddReviewButtonLabels
    - `addReviewBtnLabel` string, nullable
  - `summaryLabels` SummaryLabels
    - `aiSummary` string, nullable
    - `summaryHeader` string, nullable
  - `highlightLabels` HighlightLabels
    - `highlightHeader` string, nullable
    - `highlightFooter` string, nullable
  - `advancedReviewLables` AdvancedReviewLabels
    - `heading` string, nullable
    - `reviewCountLabel` string, nullable
    - `advancedReviews` AdvancedReviewType[], nullable
      - `visual` string, nullable
      - `type` string, nullable
      - `label` string, nullable
      - `steps` integer
      - `options` AdvancedReviewTypeLabel[], nullable
        - `label` string, nullable
        - `value` number, double
  - `wf` WidgetFlow[], nullable
    - `Session` string, nullable
    - `Timestamp` string, nullable
    - `Role` string, nullable
    - `Flow` string, nullable
    - `Deal` string, nullable
    - `API` string, nullable
    - `Click` string, nullable
    - `Channel` string, nullable
    - `Impression` string, nullable
    - `User` string, nullable
    - `Device` string, nullable
    - `FlowStep` string, nullable
    - `data` string, nullable
    - `Latitude` number, double
    - `Longitude` number, double
    - `DeviceType` string, nullable
    - `Resolution` string, nullable
    - `OS` string, nullable
    - `UserLanguage` string, nullable
    - `BrowserType` string, nullable
    - `Revenue` number, double
    - `Total` number, double
    - `DenyReason` string, nullable
    - `OptIn` string, nullable
    - `Site` string, nullable
    - `currency` string, nullable
    - `Company` string, nullable
    - `contact` string, nullable
    - `ImpressionType` string, nullable
    - `code` string, nullable
    - `referer` string, nullable
    - `email` string, nullable
    - `Agent` string, nullable
    - `flowtype` string, nullable
    - `ip` string, nullable
    - `delay` integer
    - `trigger` string, nullable
    - `emailaddrsha256` string, nullable
    - `country` string, nullable
    - `region` string, nullable
    - `domain` string, nullable
    - `path` string, nullable
    - `sitecurrency` string, nullable
    - `siteconversionrate` number, double
    - `companycurrency` string, nullable
    - `companyconversionrate` number, double
    - `apiversion` string, nullable
    - `scriptversion` string, nullable
    - `tenant` string, nullable
    - `salesforce` string, nullable
    - `new_accepts_sms` boolean
    - `new_accepts_email` boolean
    - `new_accepts_postal` boolean
    - `NPS` number, double

---

[API](https://skmtc.net/redeal/apis/redeal-widget-api-reviews.md) · [All operations](https://skmtc.net/redeal/apis/redeal-widget-api-reviews/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/redeal/redeal-widget-api-reviews/revisions/bdad5872241e/schema)