You can fetch/GET testimonials from your Shapo workspace using our API.
First, grab your API key from the Workspace settings page:
Please note: The following APIs are rate limited to 60 calls per hour, reach out to us if you need more than that.
Here's how you would structure a request:
GET https://api.shapo.io/testimonials
Authorization: Bearer <YOUR API KEY>
GET /testimonials
Query parameters (all parameters are **optional**):
size - number of testimonials to return per call (min: 1, max: 50)
page - combined with the size param, you can paginate (min: 1)
rating - minimum rating of testimonials to retrieve (min: 1, max: 5)
sources - array of testimonial sources, e.g. sources[]=judgeme&sources[]=google
tags - array of tag names associated with testimonials, e.g. tags[]=tag name1&tags[]=tag2
sort - sort results, possible values: 'newest', 'oldest', 'rating', 'random' (all options are descending order)
The response is an array of testimonials:
[
{
"_id": "12345",
"date": "2024-03-18T11:53:01.000Z",
"rating": 5,
"source": "google",
"name": "John Wayne",
"title": "Co-founder",
"company": "ACME",
"link": "https://www.acme.com",
"profileImage": "https://imgur.com/johns-profile-picture",
"message": "probably the best product in the world",
},
...
]
GET /testimonial/totals
You can also fetch summary totals for your Shapo workspace, including the total number of testimonials and the average rating.
GET https://api.shapo.io/testimonials/totals
Authorization: Bearer <YOUR API KEY>
Query parameters are optional:
status - which testimonials to count. Possible values: public, all. Defaults to public.
sources - testimonial sources to include, e.g. sources[]=judgeme&sources[]=google
tags - tag names associated with testimonials, e.g. tags[]=tag name1&tags[]=tag2
Tag matching is case-insensitive.
Example request:
GET https://api.shapo.io/testimonials/totals
Authorization: Bearer <YOUR API KEY>
Example response:
{
"total": 12,
"rating": 4.7,
"workspace": "My Workspace"
}rating is the average rating for the matching testimonials.