Product Reviews API

Fetches a company’s product catalog and detailed reviews per product including ratings, star distribution, pros, cons, pricing and individual review content.

Overview

The Product Reviews API returns a company’s product catalog and, optionally, detailed reviews for one or more of those products. When no products parameter is supplied, the response contains only the list of products belonging to the company. When products is supplied, the response is enriched with ratings, star distribution, pros, cons, pricing and individual review content sourced from review providers. Results are returned in the API response.

Endpoint Details

• Method: GET
• Endpoint: /v1/company/product-reviews

Authentication requirements

• Include a valid API key in the x-api-key request header.

Request

Request Parameters

Header Parameters

x-api-key · string · required

Your API key.

URL Parameters

company · string · required

Company website (e.g. canva.com) or a company UUID (e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6). The UUID can be obtained from the Company Search API.

products · array of strings

List of product_id values to fetch reviews for. Pass the parameter multiple times to request more than one product, for example products=177388&products=112516. Product IDs are returned by this same endpoint when called without the products parameter.

If omitted, the response returns the product list only and no reviews.

limit · integer

Maximum number of reviews to return per product. Only applies when products is provided.

Default = 0

Max value = 50

offset · integer

Number of reviews to skip before returning records. Use with limit for pagination.

Default = 0

Example Request

GET /v1/companies/product-reviews?company=canva.com&limit=10&offset=0
x-api-key: <your_api_key>

To fetch reviews for specific products, pass one or more products values:

GET /v1/companies/product-reviews?company=canva.com&products=177388&products=112516&limit=10&offset=0
x-api-key: <your_api_key>

Response

Successful Response Fields

Returns a JSON object with the following structure:

data · object

Container object holding the company’s products and, when requested, their reviews.

limit · integer

Limit applied to the request.

offset · integer

Offset applied to the request.

credits_consumed · float

Credits consumed by the request. Returns 0.0 when only the product list is fetched and a non-zero value when reviews are returned.

Product Object Fields

id · string

Unique identifier for the product. Use this value in the products query parameter to fetch reviews.

product_name · string

Display name of the product.

main_category · string

Primary category of the product. Example: Battery Storage Systems Providers.

categories · array of strings

All categories the product belongs to.

description · string

Description of the product.

rating · object

Average rating per review provider. Keys are provider identifiers (e.g. g2) and values are floats. Present only when products is provided.

star_distribution · object

Distribution of star ratings per review provider. Keys are provider identifiers (e.g. g2), values are objects keyed by star value (1 through 5) with integer counts. Present only when products is provided.

pros_list · array

Aggregated pros mentioned across reviews. Present only when products is provided.

cons_list · array

Aggregated cons mentioned across reviews. Present only when products is provided.

pricing · array

Pricing information for the product. Present only when products is provided.

reviews · object

Reviews container. Present only when products is provided. See Reviews Object Fields below.

Reviews Object Fields

data · array of objects

List of individual review objects. See Review Object Fields below.

total · integer

Total number of reviews available for the product across all providers.

total_by_provider · object

Total review count broken down by provider. Keys are provider identifiers (e.g. g2), values are integer counts.

Review Object Fields

review_id · integer

Unique identifier for the review.

review_title · string

Title of the review as submitted by the reviewer.

review_content · string

Full text of the review, including the reviewer’s answers to standard questions concatenated together.

review_question_answers · array of objects

Structured question-and-answer pairs from the review. Each object contains:

• question (string): the question prompt.
• answer (string): the reviewer’s answer.

review_rating · float

Rating given by the reviewer.

publish_date · string

Publication date of the review in ISO 8601 format.

reviewer_company_size · string

Reviewer’s company size band. Example: Small-Business(50 or fewer emp.).

review_link · string

Link to the original review on the provider’s site.

provider · string

Review provider identifier. Example: g2.

Product list only

{
    "data": {
        "uuid": "000031n-tesla",
        "product_reviews": [
            {
                "id": "177388",
                "product_name": "Powerpack",
                "main_category": "Battery Storage Systems Providers",
                "categories": [
                    "Battery Storage Systems"
                ],
                "description": "Powerpack supports a host of applications that offer commercial consumers and energy providers greater control, efficiency and reliability across the electric grid."
            },
            {
                "id": "112516",
                "product_name": "Powerwall",
                "main_category": "Battery Storage Systems Providers",
                "categories": [
                    "Battery Storage Systems"
                ],
                "description": "Powerwall integrates with solar to store excess energy generated during the day and makes it available when needed, minimizing reliance on utility."
            }
        ]
    },
    "limit": 10,
    "offset": 0,
    "credits_consumed": 0.0
}

{
    "data": {
        "uuid": "000031n-tesla",
        "product_reviews": [
            {
                "id": "177388",
                "product_name": "Powerpack",
                "main_category": "Battery Storage Systems Providers",
                "categories": [
                    "Battery Storage Systems"
                ],
                "description": "Powerpack supports a host of applications that offer commercial consumers and energy providers greater control, efficiency and reliability across the electric grid.",
                "rating": {
                    "g2": 3.8
                },
                "star_distribution": {
                    "g2": {
                        "1": 0,
                        "2": 0,
                        "3": 1,
                        "4": 0,
                        "5": 1
                    }
                },
                "pros_list": [],
                "cons_list": [],
                "pricing": [],
                "reviews": {
                    "data": [
                        {
                            "review_id": 8555613,
                            "review_title": "very easy and covinient",
                            "review_content": "What do you like best about Powerpack?\nhaving a stationaty energy powerpack for yourslef is better than easy\n\nWhat do you dislike about Powerpack?\nnothing i think its one of the most easy things to use\n\nWhat problems is Powerpack solving and how is that benefiting you?\npower pack makes charging your vehicle very easy and convienient",
                            "review_question_answers": [
                                {
                                    "question": "What do you like best about Powerpack?",
                                    "answer": "having a stationaty energy powerpack for yourslef is better than easy"
                                },
                                {
                                    "question": "What do you dislike about Powerpack?",
                                    "answer": "nothing i think its one of the most easy things to use"
                                },
                                {
                                    "question": "What problems is Powerpack solving and how is that benefiting you?",
                                    "answer": "power pack makes charging your vehicle very easy and convienient"
                                }
                            ],
                            "review_rating": 4.5,
                            "publish_date": "2023-09-01T00:00:00",
                            "reviewer_company_size": "Small-Business(50 or fewer emp.)",
                            "review_link": "https://www.g2.com/products/powerpack/reviews/powerpack-review-8555613",
                            "provider": "g2"
                        },
                        {
                            "review_id": 1100483,
                            "review_title": "my ever favorite vehicle",
                            "review_content": "What do you like best about Powerpack?\nthe best thing is all computerized and easy to operate and less fuel consumption\n\nWhat do you dislike about Powerpack?\nnothing for dislike ... except its all electronic so need extra care while service\n\nWhat problems is Powerpack solving and how is that benefiting you?\npower pack is complete paperless desk and its easy to use and sharing with others.",
                            "review_question_answers": [
                                {
                                    "question": "What do you like best about Powerpack?",
                                    "answer": "the best thing is all computerized and easy to operate and less fuel consumption"
                                },
                                {
                                    "question": "What do you dislike about Powerpack?",
                                    "answer": "nothing for dislike ... except its all electronic so need extra care while service"
                                },
                                {
                                    "question": "What problems is Powerpack solving and how is that benefiting you?",
                                    "answer": "power pack is complete paperless desk and its easy to use and sharing with others."
                                }
                            ],
                            "review_rating": 3.0,
                            "publish_date": "2018-11-03T00:00:00",
                            "reviewer_company_size": "Small-Business(50 or fewer emp.)",
                            "review_link": "https://www.g2.com/products/powerpack/reviews/powerpack-review-1100483",
                            "provider": "g2"
                        }
                    ],
                    "total": 2,
                    "total_by_provider": {
                        "g2": 2
                    }
                }
            }
        ]
    },
    "limit": 10,
    "offset": 0,
    "credits_consumed": 1.5
}