Website Embed

SocialClimb provides iframes to our customers which can be used to display patient reviews or review averages that are within the SocialClimb application to a website.

Enable iframes in your account: https://app.socialclimb.com/app/settings/account-iframe

If you are only interested in the data within the iframe but don’t want the html then you can use the iframe api endpoint that we provide.

The iframe API endpoint follows the exact same format as the iframe urls except for the addition of /api in the path.

• Example iframe:https://iframe.socialclimb.com/iframe/<iframe_token>/reviews
• Example API:    https://iframe.socialclimb.com/iframe/api/<iframe_token>/reviews

You can find the public api key value to use within the <iframe_token> in “Settings”->“Reviews iframe” in the SocialClimb App

We support many of the arguments from the ‘iframe Reviews’ page as parameters when requesting the iframe or the iframe API, if these parameters are not provided then the values set on the iframe settings page will take precedence.

Parameters available to all iframe api endpoints:

• doc=1234,5678
  • Filter by provider id, use commas to filter by multiple
• loc=1234,5678
  • Filter by location id, use commas to filter by multiple
• plats=1234,5678
  • Filter by platform id, use commas to filter by multiple

These Parameters below are only available to the https://iframe.socialclimb.com/iframe/api/<iframe_token>/reviews iframe endpoint:

• limit=12

  • Limit the number of reviews returned

• min_rating=4

  • Integer of the minimum rating of the reviews returned

• Start and End dates:

  • start=2023-10-09
  • end=2023-10-11
  • If start date is provided but no end date is provided, the end of the range will be set to 24 hours after the start date
  • If end date is provided but no start date is provided, this will pull any reviews that match the other specified parameters that were created before end-of-day on the specified end date, ordered newest to oldest
  • If both dates are provided, this will pull any reviews created between the provided dates that match the other specified parameters
  • All date values will be evaluated in UTC

https://iframe.socialclimb.com/iframe/api/<iframe_token>/reviews
?doc=1234,5678
&loc=1234,5678
&plats=1234,5678
&limit=12
&min_rating=4
&start=2023-10-09
&end=2023-10-11

iframes follow this general format

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/<endpoint>" width="720" height="400">
  <p>Your browser does not support iframes.</p>
</iframe>

Unfiltered reviews

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/reviews" width="720" height="400">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to a location reviews

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/reviews?loc=<loc_id>" width="720" height="400">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to a doctor reviews

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/reviews?doc=<doc_id>" width="720" height="400">
  <p>Your browser does not support iframes.</p>
</iframe>

Unfiltered averages

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/averages" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to a location averages

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/averages?loc=<loc_id>" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to a doctor averages

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/averages?doc=<doc_id>" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to one survey

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/survey-average?survey=<survey_id>" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to one survey and one location

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/survey-average?survey=<survey_id>&loc=<loc_id>" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Filtered to one survey and one doctor

<iframe src="https://iframe.socialclimb.com/iframe/<iframe_token>/survey-average?survey=<survey_id>&doc=<doc_id>" width="720" height="55">
  <p>Your browser does not support iframes.</p>
</iframe>

Once the iframe has been enabled in your account, some granular settings can be configured. Below is an image showing all the different settings that can be changed. The different settings that can be configured include:

• Maximum Rating
• Reviews Limit
• Font size for the Averages iframe
• Font size for the Reviews iframe
• Show/Hide private reviews
• Show/Hide reviewer’s last name
• Horizontally center Averages iframe
• View Reviews iframe in grid format
• Filter iframe by Platform
  

If you’re using our reviews iframe, it comes with ability to be styled to match your brand. These inputs work off of hex values and allow hex values with or without alpha channels (i.e. #000000 and #00000000 will work). Below are all of the options that can be edited with your own hex value to style the reviews iframe.

• Background Color
• Background Card Color (used for card color if “View reviews in grid format” is toggled on)
• Star Color (Filled In)
• Star Color (Not Filled In)
• Font Color

Something to note is that when initally enabling iframe’s for your account, there will be default SocialClimb colors for your account. If at anytime you wish to change back to these colors, just click the “Restore Default Colors” and click “Save” to reset the reviews iframe colors.

The standard layout can be used at any time by adding ?layout=rows to the end of the reviews url.

• Example: https://iframe.socialclimb.com/iframe/..../reviews?layout=rows

The grid layout can be used at any time by adding ?layout=grid to the end of the reviews url.

• Example: https://iframe.socialclimb.com/iframe/..../reviews?layout=grid