Overview
The Product Reviews API returns product review data for a given company. Pass a company website or company UUID in thecompany query parameter.
Each result represents a reviewed product and includes the product name, average rating, star distribution, and a list of review summaries.
Endpoint Details
- Method:
GET - Endpoint:
/v1/companies/reviews - Base URL:
https://api.akta.pro
Authentication
Pass your API key in thex-api-key request header.
Request
Query Parameters
string
required
Company website or company UUID. Example:
canva.com or 3fa85f64-5717-4562-b3fc-2c963f66afa6. Company UUIDs can be obtained from the Company Search API.integer
Maximum number of reviews to return per product. Default:
10. Max: 100.integer
Number of results to skip. Default:
0.string
Product filtering parameter used to return reviews for selected products.
Response
Successful Response Fields
Returns a JSON object with the following structure:string
Request status. Returns
success or error.array
Array of product review objects.
object
Pagination metadata for the returned result set.
Product Review Object Fields
string
Name of the reviewed product.
float
Overall average rating. Example:
4.5.object
Count of reviews by star rating. Keys are
"1" through "5".array
Array of individual review summary objects.
Review Object Fields
string
Unique identifier for the review. UUID format.
string
Title of the review.
Pagination Object Fields
integer
Total number of matching results.
integer
Maximum number of reviews returned per product.
integer
Number of results skipped before the current response.
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=e0cafcb914826d8adc60e5092187e1ca)
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=f214ebe0a940d8aa0f19a709a6bfd7fa)