Skip to main content

Star Ratings API (Comments)

Introduction​

The Press Ganey Consumer Experience API is a set of HTTP based REST services. There is also a JavaScript wrapper that abstracts the low level API calls. The Press Ganey Consumer Experience API can be used by third party websites to embed data from the Transparency platform within a target web page. Testimonials are patient feedback collected through surveys and pass through a series of checks before they are made available through the API. The main checks include:

  • Profanity and PHI information is flagged by the NLP process to ensure that high-risk content is not available for public consumption

  • A unique location or physician identifier (NPI) is required during the API call to publish testimonials specific to the location or the physician. The unique identifiers are defined during the client setup process.

    o Section 1: Allows for publishing testimonials by NPI

    o Section 2: Allows for publishing testimonials by Location

    o Section 3: Allows a rollup score to be published for any physician or location. Note: It is recommended to use a 365 day or lesser date range for roll up scores.

  • The maximum age filter (in days) limits the age of the testimonials published through the API call. By default, each API call generates testimonials that are less than 365 days old.

  • The minimum number of ratings limit ensures that there are adequate number of ratings used to compute the overall star ratings for the physician or location. The default value is 0 ratings.

  • An optional maximum count filter to limit the number of testimonials published through the API call per page. By default, each API call generates up to 20 testimonials.

Other optional parameters are included in the various API calls and are detailed below.

API Reference​

Before using the API, an Application must be provisioned by Press Ganey Consumer Experience Team. Two pieces of information are required to create the application – an easily identifiable name and the domain of the website that hosts the pages invoking the API. The domain name is needed without the http(s) protocol schemes and the slashes - if the URL is http://www.w3schools.com/, the domain name is www.w3schools.com. Press Ganey Consumer Experience will provision the Application and make it available in the API settings page on the Transparency platform. The Application ID and Application Secret create a unique combination that will be used for authorization in all the API calls.

Use the Application ID and Application Secret to receive an Access Token to start making server to server API calls. The access token is valid for a limited period of time. The server-to-server API calls are:

API Restrictions​

  • All APIs have a default throttling of 5 requests/second. If you are going beyond that, you will receive a HTTP 429 Too Many Requests