Skip to main content
API
Lorianne avatar
Written by Lorianne
Updated in the last 15 minutes

REVIEWS.ai provides an easy to use API, allowing you to import your review and Q&A data to other business intelligence tools such as PowerBI, Tableau or Looker.

To get API tokens and other relevant data, click API from the top navigation menu. This will open the below API page.

If your preferred business tool requires a REVIEWS.ai token, simply click: GENERATE.

Refer to the table for definitions and structure of the various parameters, such as IDs and time periods.

Reviews.ai API Documentation

The Reviews.ai API allows you to retrieve product and review data efficiently. You can fetch product IDs, filter reviews by brands or categories, set time periods, and control pagination.

1. Get Product IDs

Retrieve product IDs, which can then be used to fetch related review data.

Endpoint

https://app.reviews.ai/api/products.php?token={your_token}

Request Parameters

None

Response

Returns a list of product IDs that can be used in subsequent API calls.


2. Get Reviews

Retrieve reviews based on specific products, brands, categories, and more.

Endpoint

GET https://app.reviews.ai/api/reviews.php?token={your_token}

Request Parameters

Parameter

Example

Default

Description

ids/brands

/category/tag

ids=35923,25534

brands=Sony,Microsoft

category=kitchen

tag=food

N/A

Fetch reviews for specific product IDs, brands, or categories. Multiple values should be separated by commas.

period (day, days_7, month)

period=day

day

Defines the time range for retrieving reviews. Available options: day (daily data), days_7 (weekly data), and month. Contact your account manager for large data exports. To export data beyond a month, go to Reports > Charts & Graphs and click Download .csv.

page

page=1

1

Enables pagination for better handling of large datasets.

limit (10, 20, 30, 50, 100)

limit=20

10

Defines the number of reviews returned per page.

status (active, inactive, all)

status=active

active

Determines the type of reviews retrieved: active (latest and available), inactive (filtered/deleted from retail sites), or all.

Example API Call

https://app.reviews.ai/api/reviews.php?token=xxxxxx&brands=Sony&period=day

Best Practices

Use Pagination: Set limit (max 100) and page for efficient data retrieval.
Filter by Status: Use status=active to focus on current reviews.
Optimize Queries: Combine brands, ids, category, and period for precise results.
Rate Limits: The API allows a maximum of 300 requests per minute to prevent throttling.
Secure API Tokens: Keep your token confidential and avoid exposing it publicly.

API Response Fields Documentation

The API returns a structured JSON response with detailed review data. Below is a breakdown of the fields included in the response:


Basic Review Details

Field Name

Example Value

Description

Id

"44346733"

Unique identifier for the review.

Product Id

"74756"

Unique identifier for the reviewed product.

Date

"02/17/2025"

Date when the review data was recorded.

Brand

"Iams Store"

Name of the brand associated with the product.

Product

"IAMS Adult Minichunks Small Kibble High Protein Dry Dog Food with Real Chicken, 30 lb. Bag"

Full product name.

Rating

"5"

Star rating given by the reviewer (scale of 1-5).

Source

"amazon"

The platform where the review was posted.

Review Status

"Active"

Indicates if the review is currently active, inactive, or filtered.

Review Status Date

"02/18/2025"

Date when the review status was last updated.

Review Posted Date

"02/18/2025"

The original posting date of the review.


Reviewer Details

Field Name

Example Value

Description

Reviewer Name

"U44346733"

Anonymized or publicly available name of the reviewer.

Reviewer ID

"AFGL5GGHTKIYXJFSRM6WJFRSW2CA"

Unique identifier for the reviewer.


Review Content

Field Name

Example Value

Description

Review

"My dog has been eating IAMS Minichunks for years, and it’s been a great choice for her!"

The full text of the review.

Review ID

"RK9NTYSVJY564"

Unique identifier for the review entry.

ReviewTranslated

""

Translated review content (if applicable).

Title

"Dog Approved"

Review title given by the user.


Review Attributes & Metadata

Field Name

Example Value

Description

Syndicated

"No"

Indicates if the review was syndicated from another platform.

Incentive Program

"N/A"

Specifies if the review was incentivized (e.g., discounts, free products).

Verified Review

"Yes"

Confirms whether the review is verified.

Helpful Votes

0

Number of users who marked the review as helpful.

Top Contributor

"No"

Indicates if the reviewer is recognized as a top contributor.

Media (Picture/Video)

"No"

Indicates whether the review includes media attachments.

Displayed Rating

"N/A"

The rating displayed to users on the review platform.


Product & Pricing Information

Field Name

Example Value

Description

Price

"N/A"

Price of the product at the time of review (if available).

Size

"N/A"

Product size specified in the review.

Color

"N/A"

Product color specified in the review.

Edition

"N/A"

Product edition specified in the review.

Style

"N/A"

Product style specified in the review.

Model

"N/A"

Product model (if available).

ASIN

"B00BD741WM"

Amazon Standard Identification Number (ASIN).

ASIN Reviews Link

"https://www.amazon.com/product-reviews/B00BD741WM/ref=cm_cr_arp_d_rvw_fmt?ie=UTF8"

Direct link to Amazon reviews for the product.

SKU

"B00BD741WM"

Stock Keeping Unit (SKU) for the product.


Category & Tagging

Field Name

Example Value

Description

Category

"Pet Supplies"

The category to which the product belongs.

Tag

"Dry"

Relevant tag assigned to the product.

Keyword Tagging

"N/A"

Keywords assigned to the review for search and classification.


Sentiment Analysis & NPS

Field Name

Example Value

Description

NPS

"76.92"

Net Promoter Score (percentage-based customer loyalty indicator).

Sentiment Score

0.9

Score indicating positive or negative sentiment (range: -1 to 1).

Sentiment Magnitude

4.8

Strength of the sentiment detected in the review.


Topic Categorization

Field Name

Example Value

Description

Negative Topic Categories

"N/A"

Identified negative themes in the review.

Positive Topic Categories

"Long-term Satisfaction,Kibble Size,Taste,Ingredients,Digestive Health,Coat Health"

Identified positive themes in the review.

Negative Top Level Topics

"N/A"

Broader negative topics identified.

Positive Top Level Topics

"Satisfaction & Enjoyment: Long-term Satisfaction; Size & Quantity: Kibble Size; Taste & Texture: Taste; Ingredients & Composition: Ingredients; Digestion & Stomach Issues: Digestive Health; Coat Health: Coat Health"

Higher-level positive topics extracted from the review.


Review Interaction & Response

Field Name

Example Value

Description

Status

"Open Ticket"

Internal status of the review (e.g., open, closed).

Replied To

"No"

Indicates whether the brand has responded to the review.

Replied User

"N/A"

Name of the user who replied (if applicable).

Replied Date

"N/A"

Date when the response was posted.

Internal Comments

"N/A"

Internal notes added by the support team.


Links & System Identifiers

Field Name

Example Value

Description

Permalink

"https://www.amazon.com/gp/customer-reviews/RK9NTYSVJY564/ref=cm_cr_othr_d_rvw_ttl?ie=UTF8&ASIN=B00BD741WM"

Direct link to the original review on Amazon.

System ID

"44346733"

Internal system identifier for the review.


Additional Metadata

Field Name

Example Value

Description

Path2Purchase

"N/A"

Details about the customer's journey before purchasing the product.

Syndicated From

"N/A"

Indicates if the review was syndicated from another source.

Did this answer your question?