Trustpilot APIs - Service Review Integration Guidelines

This feature is part of the Connect add-on module, which can be purchased in addition to the Premium and Advanced plans, and is included in the Enterprise plan.

Version 2.7 - November 2020

Want to build an integration or custom widget that displays your service review data? Our Integration Guidelines will help you implement your Trustpilot review content and display our logo and images correctly. Read more about them here. 

Important: These guidelines apply to everyone permitted to use our APIs, and Trustpilot reserves the right to revoke your API access if you violate our guidelines. If you want to ensure that you always display data that is compliant, we recommend using one of our TrustBox widgets.

Content requirements

It's important that you're following Trustpilot’s content requirements when using our APIs. Here's some tips:

Do

  • You must indicate which reviews you're displaying in your widget.  
    • If displaying reviews by star rating, adapt the text “Showing our X- & X- star reviews” based on what star rating(s) you've chosen. For example, if you're only displaying 5-star reviews, show the text “Showing our 5-star reviews”.
    • If displaying all reviews, show the text “Showing our latest reviews”.
    • If displaying your favorite or tagged reviews, show the text “Showing our favorite reviews”.
  • Store your data in your own backend system, so you can display reviews or ratings on your site.
  • Display your accurate overall score either as a star rating (star image), TrustScore (number) or star label (text).
  • Display your total number of reviews.
  • Link back to Trustpilot, so customers can read your reviews in full.

Don't

  • Edit the content of a review, including TrustScore, text, author, date, etc.
  • Publicly display sensitive information, e.g., customer emails, reference numbers.
  • Display information in a libelous or defamatory, obscene, malicious, or discriminatory manner.
  • Index reviews to get review snippets or display them as your own content.
  • Share your API key with 3rd parties who are not a part of your API development.

You don’t have to show your category ranking, but if you do, make sure it’s accurate.

Here's a breakdown of some of our terminology: 

Sample Trustpilot score with a breakdown of what each term means

How to display your overall TrustScore correctly:

SEO requirements

Follow Trustpilot’s SEO requirements to avoid duplicate content penalties and damage to your search engine rankings.

Do

  • Dynamically load the data with JavaScript from a site where the robots.txt prevents search engines from crawling the JavaScript. For example, you can dynamically load the data client-side through Trustpilot APIs on developers.trustpilot.com.
  • Use an Iframe where the framed page isn’t crawlable by search engines. For example, you can “no-index” the framed page or remote load the framed page from a website where robots.txt prevents search engines from crawling it.

Don't

  • Include Trustpilot reviews directly in your source code.
  • Don’t mark up your TrustScore to get review snippets on your own site. For more information, read our blog post about what Google's changes to review snippets mean for Trustpilot customers.

Branding requirements

Following Trustpilot’s branding requirements establishes review credibility. It confirms that your reviews come from a trusted and independent third-party source.

Do

  • Include at least one Trustpilot logo on every page displaying reviews or ratings.
  • Place the logo close to the overall TrustScore or reviews.

Don't

  • Display the review content as your own, without mentioning Trustpilot.

For more details on how to display the Trustpilot logo and star images, visit our Brand Style Guide.

How to display the Trustpilot logo correctly:

Do and Don'ts of Trustpilot Reviews

 

How partners can give credit to Trustpilot when displaying reviews:

Do's and Don'ts of giving credit to Trustpilot

API documentation

Now that you’ve read our guidelines, you’re ready to build your API integration with Trustpilot. Our API documentation has everything your developer needs to know.

Related articles