Niq's OA Resources

OA Review Widget

OA's Custom Review Widget v4.0

Pull a company's Google, Neary Now, and/or To Your Success reviews onto their website into an easy to set up, customizable widget.

Version 4.0: The slider option of the widget has been replaced with the new OA carousel option, as well as some minor quality of life improvements


Use the tools below to build your widget. Just make sure you let it finish loading before loading a new one.

Also, you can check "for external site" so that the code should work if you put it on a not pagepilot site (note: there are a dozen factors that could affect it, and if you have issues implimenting, reach out to developers)

Build a Review Widget

Set the widget properties

Choose an effect:

Copy the code below and paste on one of our websites to load your widget!

Options

placeID

You need either this or the Nearby Now storefrontKey to get the widget to load. Pulls the reviews from Google. (recomment using the {#googleplaceid} tag)
IMPORTANT: we need to have access to their Google listing in our Google Business account for the reviews to populate. (seperate by commas)

storefrontKey

You need either this or the Google placeId to get the widget to laod. Pulls the reviews from Nearby Now. Recomment using the {#NBNSFT} tag. (seperate by commas)

toYourSuccessClient

Add the 4-digit To Your Success Client Key to pull the reviews from that platform. (seperate multiple by commas)

companyName

In quotations you can customize the name of the company, it does not pull the company name from Google. You should be fine leaving {#Companyname} in to pull the company name, but if they have a shortening of it, you could manually replace it (or spell it out on websites outside the PP system).

effect

New 4 options: "slider", "scrollBox", "latestBoxes", or "fullReviewPage"
• "slider" is the effect seen above. Puts the reviews into a simple slider. add the option "slidesAtOnce" to dictate how many slides show up in the slider at once.
• "scrollBox" is putting the reviews into a list of reviews, that has a scrollbar in its container to show reviews outside its contianer.
• "latestBoxes" puts the reviews in flexboxes in a row. There is hard limit of 12 reviews on this widget, as to not overwhelm a page, but you can do less with the charLimit. I would recommend not defining the height for this widget.
• "fullReviewPage" puts the number of reviews you put in the charLimit into a flexable container that vertically lists the latest reviews. Ideal for review pages.

If there is not a string selection put in, or an incorrect input, it'll just load a list of the reviews, breaking the height of the container.

reviewLimit

Limits the number of reviews that are pulled into the widget. It will always pull the latest reviews. If you set a number over the amount of reviews on the account, you put an invalid entry, or you do not utilize this option, it'll default to 25 reviews (or if the total is less, it'll pull all the reviews).
The "latestBoxes" widget will pull only the 5 latest reviews if there is not a reviewLimit input, or you go over the max of 12 reviews.

charLimit

Limits the characters to show up in a review. If a review has more than the amount of characters you specified, it'll throw the rest under a readmore, with an overflow scroll on said boxes once readmore is clicked. (important to pay attention to for smaller widgets)
If not defined, the entirety of a review will be pulled into its container.

boxHeight

Defines the height of the review box in pixels. (this does not affect the titlebar)
If there is not an input, "slider" will default to 300px, and "scrollBox" will default to 500px.

boxWidth

Defines the width of the review box in pixels. Width for slider, max-width for the other widgets,
If there is not an input, it will default to 100%.

These are options specific to the slider choice

slidesAtOnce

If the slider effect is selected, you can can have more than one slide at a time show up. If using more than one, it's recommended to use the breakpoint option to have the number of slides drop down at lower screen sizes.

breakPoint

If the number of slidesAtOnce is more than 1, this is the screen's pixel width at which the number of slides will drop down at one, to work with responsive design. If null, it wont shrink the number of slides at once responsively. Either enter a single integer for the pixel width you want it at (example: breakPoint: 900, ...) or do an array of multiple integers for each descending screen size you want the slide at once count to drop at (example: breakPoint: [1000,700,400], ...)

slideSpeed

The speed of the animation of the slide movement, in ms (1/1000 of a second). Input must be a whole number (integer).

autoSlideInterval

Choose if you want the carousel to automatically slide when not hovered over. Options are 'right' to have it auto slide right, 'left' to have it auto slide left, or 'disable' to not have it automatically slide