JSON AI Review Summaries API

The JSON AI Review Summaries API allows you to access AI-generated summaries of reviews collected for your products, and (optionally) deeper AI Aspects analysis.

Accessing AI summaries

Note: The JSON AI Review Summaries API must be enabled by TestFreaks for your client ID.

The API takes your client ID, and either the product ID or the family ID.

Using a product ID:

https://cr.testfreaks.com/ai-summaries.json?client_id=your.client.id&product_id=PRODUCT001

Using a family ID:

https://cr.testfreaks.com/ai-summaries.json?client_id=your.client.id&family_id=FAMILY001

Note: Replace your.client.id with one of your assigned client IDs.

See Product Feed for an explanation of the product and family concepts.

Response Format

The API returns a JSON response that always contains the following fields:

  • content: the AI-generated summary, typically a few sentences of text
  • number_of_reviews: the number of reviews used for the summary
  • date: the date when the summary was generated

Example response (without aspects)

{
  "content": "The product reviews are summarized in a few sentences.",
  "number_of_reviews": 73,
  "date": "2025-03-18"
}

AI Summary Aspects

If enabled for your client and if sufficient reviews exist, the response is extended with an aspects array. Each item represents a specific facet mentioned by reviewers (e.g. Comfort, Battery Life).

Example response (with aspects)

{
  "content": "The product reviews are summarized in a few sentences.",
  "number_of_reviews": 73,
  "date": "2025-03-18",
  "aspects": [
    {
      "name": "Comfort",
      "content": "Most find this product comfortable to use.",
      "number_of_positive_reviews": 123,
      "number_of_negative_reviews": 15,
      "date": "2025-03-18",
      "quotes": [
        {
          "positive": true,
          "content": "...Feels great on the foot...",
          "highlight": "Feels great"
        }
      ]
    }
  ]
}

Aspect Fields

Field Description
name Name of the identified aspect (e.g. “Battery Life”).
content AI-generated sub-summary for this aspect.
number_of_positive_reviews Count of reviews mentioning this aspect positively.
number_of_negative_reviews Count of reviews mentioning this aspect negatively.
date Date of the aspect generation (YYYY-MM-DD).
sentiment Whether this quote expresses a positive, neutral, or negative sentiment (a string with one of these values).
quotes Array of example review excerpts for this aspect.

Quote Fields

Field Description
date Date when the review was published (YYYY-MM-DD).
author Author name.
positive Whether this quote expresses a positive sentiment (true/false).
content Quote from the full review.
highlight Highlighted portion of the quote most relevant to this aspect.

Notes

  • Aspects are generated only if enabled for the client configuration and the review volume threshold is met.
  • The number of aspects generated is configurable (e.g. 3 to 8).
  • If no aspects are available, the API will simply return the base summary fields.