Reputation Summary API for Entity

Introduction

The Reputation Summary API for Entity provides a comprehensive overview of an entity's reviews, both at the aggregate level and broken down by individual source.

Endpoint

GEThttps://api1.consumerism.pressganey.com/api/reputation/v1/review/summary

Header Parameters

Property	Type	Description	Required/Optional
accessToken	String	Access token received from the platform.	Required

Get Request Parameters:

Parameter	Type	Description	Required/Optional
providerCode	String	This field accepts a provider code.In most cases, we are expecting an NPI here.	Either locationCode or providerCode is mandatory.
locationCode	String	This field accepts a location code.	Either locationCode or providerCode is mandatory.

JSON Response

{
   "summary": [
     {
       "type": "Overall",
       "content": "TSC Hospital is a leading healthcare institution committed to delivering exceptional medical services and compassionate care to individuals and families in our community. With state-of-the-art facilities, a team of highly skilled healthcare professionals, and a patient-centered approach, TSC Hospital strives to be a beacon of health and healing.Hospital boasts specialized care units, including intensive care units (ICUs), cardiac care units (CCUs), neonatal intensive care units (NICUs), and surgical recovery units. These units are equipped with advanced monitoring systems and staffed by experienced healthcare professionals to provide specialized care to patients with complex medical needs.Our hospital offers a comprehensive range of diagnostic services, including laboratory testing, imaging studies (X-rays, CT scans, MRI scans), ultrasound, endoscopy, and biopsies. Accurate and timely diagnosis is crucial for effective treatment planning, and our advanced diagnostic tools ensure precise results.Hospital provides a wide array of medical and surgical treatments, ranging from routine procedures to complex surgeries. Our specialties include orthopedics, cardiology, oncology, neurology, gastroenterology, obstetrics and gynecology, pediatrics, and more. Our skilled physicians and surgeons use the latest techniques and technologies to deliver optimal outcomes for our patients.Hospital is dedicated to supporting mothers and children throughout their healthcare journey. We offer prenatal care, childbirth services, postnatal care, pediatric care, immunizations, and specialized care for newborns and infants. Our maternal-fetal medicine specialists and pediatricians provide personalized care to ensure the health and well-being of both mother and child.",
       "ratingN": 50,
       "ratingStar": 4.1,
       "ratingText": "4.1 Stars based on 50 Reviews"
     },
     {
       "type": "Google",
       "content": "TSC Hospital is a leading healthcare institution committed to delivering exceptional medical services and compassionate care to individuals and families in our community. With state-of-the-art facilities, a team of highly skilled healthcare professionals, and a patient-centered approach, TSC Hospital strives to be a beacon of health and healing.Hospital boasts specialized care units, including intensive care units (ICUs), cardiac care units (CCUs), neonatal intensive care units (NICUs), and surgical recovery units. These units are equipped with advanced monitoring systems and staffed by experienced healthcare professionals to provide specialized care to patients with complex medical needs.Our hospital offers a comprehensive range of diagnostic services, including laboratory testing, imaging studies (X-rays, CT scans, MRI scans), ultrasound, endoscopy, and biopsies. Accurate and timely diagnosis is crucial for effective treatment planning, and our advanced diagnostic tools ensure precise results.Hospital provides a wide array of medical and surgical treatments, ranging from routine procedures to complex surgeries. Our specialties include orthopedics, cardiology, oncology, neurology, gastroenterology, obstetrics and gynecology, pediatrics, and more. Our skilled physicians and surgeons use the latest techniques and technologies to deliver optimal outcomes for our patients.Hospital is dedicated to supporting mothers and children throughout their healthcare journey. We offer prenatal care, childbirth services, postnatal care, pediatric care, immunizations, and specialized care for newborns and infants. Our maternal-fetal medicine specialists and pediatricians provide personalized care to ensure the health and well-being of both mother and child.",
       "ratingN": 37,
       "ratingStar": 4.3,
       "ratingText": "4.3 Stars based on 37 Reviews"
     }
   ],
   "lastUpdated": "2024-04-02"
 }

Response Parameters

Property	Type	Description
summary	Array	This will contain overall and source specific summary data.
summary.type	String	Returns type of summary either overall or source specific summary.
summary.ratingText	String	Returns text with star rating based on number of reviews.
summary.ratingStar	Double	Returns star rating value.
summary.ratingN	Integer	Returns count of reviews where the summary is dependent upon.
summary.content	String	Returns content text of review summary.
lastUpdated	String	When the review summary lastUpdated in the ISO 8601 date format.