API module best practices
If you’re a Trustpilot for Business user, you can sign up to the API module add-on and use the Trustpilot for Business API.
The API module gives you access to your business data through a range of endpoints. You can use the API to access your business information, access your review data and generate review invitation links.
API module tiers
Section titled “API module tiers”The API module is available in three tiers that suit different use cases.
The following table describes the tiers, and their yearly API call allowances:
| Tier | API calls per year |
|---|---|
| API module tier 1 | 200,000 |
| API module tier 2 | 1,000,000 |
| API module tier 3 | Unlimited |
If you’re on the Enterprise plan, you have access to API Module Tier 1 and unlimited invitations as part of your plan.
What’s included within your allowance
Section titled “What’s included within your allowance”If you want to keep your API calls within your allowance, it’s good practice to make sure you know which API calls go towards your allowance and which don’t. To do this, refer to the following table:
| API call type | APIs | Goes towards your allowance |
|---|---|---|
| API calls that return Trustpilot data. Such as fetching TrustScores to power a custom widget. | Business Units API, Business Units API (public), Categories API, Consumer API, Consumer profile API, Private products API, Product reviews API, Resources API, Service reviews API | ✔️ |
| Unsuccessful API calls to return Trustpilot data caused by errors in your implementation. | ✔️ | |
| Unsuccessful API calls caused by errors on Trustpilot’s side. | X | |
| Invitations generated via the API | Invitations API | X These count towards your monthly invitation allowance instead |
| Legal compliance calls, such as the Deletions endpoint | Deletions API | X |
For further information about the types of error you might receive and how to fix them, refer to Common error messages.
How much data is returned per call
Section titled “How much data is returned per call”Endpoints often have defined use cases, this means that they’ll return different amounts of data for a single API call. The table below shows the quantity of data you’ll get for a single call to a commonly used endpoint:
| Endpoint | Max quantity returned (Dependant on parameters) | Data Type returned |
|---|---|---|
| Business Unit Reviews | 100 reviews or 1MB of data | Service reviews |
| Business Unit | 1 business unit | Business Unit trustscore, number of reviews |
| Product Reviews for specific SKUs | 100 product reviews | Product reviews |
| Product Reviews | 1,000 product review summaries | Product review summaries including average stars and number of stars per product |
| Products | 10,000 products | Product information |