The Review Summaries API shows what information TestFreaks has about your product catalog, and the number of reviews and average rating per product or product family.
limit, how many products per page, default 100, maximum 1000
client_id, the unique identifier for your client configuration.
by_family, if set to 1 or true, group the summaries by product family instead of
product. See below for separate documentation.
after, used for pagination
See below, and see the separate description of fields.
If .links.next is set, additional pages are available by following the link.
If .errors is set, it’s a list of errors.
$ curl -u "sk_token:" "https://api.testfreaks.com/v1/summaries?client_id=example.com&limit=2"
{
"data": [
{
"your_review_count": 2,
"your_avg_score": 4.5,
"pro_review_count": 0,
"user_review_count": 0,
"score": 9,
"your_score_dist": [
0,
0,
0,
1,
1
],
"your_review_answers": null,
"id": "1001-01",
"family_id": "1001",
"title": "Apple iPhone 12",
"brand": "Apple"
},
{
"your_review_count": 1,
"your_avg_score": 5,
"pro_review_count": 0,
"user_review_count": 0,
"score": 10,
"your_score_dist": [
0,
0,
0,
0,
1
],
"your_review_answers": null,
"id": "1001-02",
"family_id": "1001",
"title": "Apple iPhone 13",
"brand": "Apple"
}
],
"links": {
"next": "https://api.testfreaks.com/v1/summaries?after=1001-02&limit=2"
}
}
limit, how many product families per page, default 100, maximum 1000
client_id, the unique identifier for your client configuration.
after, used for pagination
See below, and see the separate description of fields.
If .links.next is set, additional pages are available by following the link.
$ curl -u "sk_token:" "https://api.testfreaks.com/v1/summaries?client_id=example.com&by_family=1"
{
"data": [
{
"your_review_count": 3,
"your_avg_score": 4.7,
"pro_review_count": 0,
"user_review_count": 0,
"score": 9.3,
"your_score_dist": [
0,
0,
0,
1,
2
],
"your_review_answers": null,
"family_id": "1001"
},
{
"your_review_count": 11,
"your_avg_score": 4.6,
"pro_review_count": 0,
"user_review_count": 0,
"score": 9.3,
"your_score_dist": [
0,
0,
1,
2,
8
],
"your_review_answers": null,
"family_id": "1002"
},
{
"family_id": "1003"
},
],
"links": {
"next": "https://api.testfreaks.com/v1/summaries?by_family=1&after=1003"
}
}