Akta: Product Reviews

Retrieving a company product catalog or detailed product reviews.

Tool ID: akta_product_reviews

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'akta_product_reviews',
  {
    "company": "Example Corp"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute akta_product_reviews --input '{
  "company": "Example Corp"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "data": {
      "uuid": "uuid_123",
      "product_reviews": [
        {
          "id": "id_123",
          "product_name": "Example",
          "main_category": "example"
        }
      ]
    },
    "limit": 123,
    "offset": 123
  }
}

Use deepline tools get akta_product_reviews --json for the latest machine-readable contract.

Input reference

Fetches a company’s product catalog and detailed reviews per product including ratings, star distribution, pros, cons, pricing and individual review content. Results are returned in the API response.

Name	Type	Required	Default	Details
`payload.company`	`string`	Yes	—	Company website (e.g. ‘canva.com’) or a company UUID. The UUID can be obtained from the Company Search API.
`payload.products`	`array`	No	—	List of product_id values to fetch reviews for. Pass the parameter multiple times to request more than one product. If omitted, the response returns the product list only.
`payload.limit`	`integer`	No	`0`	Maximum number of reviews to return per product. Only applies when products is provided. Maximum: 50.
`payload.offset`	`integer`	No	`0`	Number of reviews to skip before returning records. Use with limit for pagination.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	—
`result.data.data.uuid`	`string`	No	—	—
`result.data.data.product_reviews`	`array`	No	—	—
`result.data.data.product_reviews[].id`	`string`	No	—	Unique identifier for the product. Use this value in the products query parameter to fetch reviews.
`result.data.data.product_reviews[].product_name`	`string`	No	—	Display name of the product.
`result.data.data.product_reviews[].main_category`	`string`	No	—	Primary category of the product.
`result.data.data.product_reviews[].categories`	`array`	No	—	All categories the product belongs to.
`result.data.data.product_reviews[].description`	`string`	No	—	Description of the product.
`result.data.data.product_reviews[].rating`	`record`	No	—	Average rating per review provider. Keys are provider identifiers (e.g. g2) and values are floats. Present only when products is provided.
`result.data.data.product_reviews[].star_distribution`	`record`	No	—	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.
`result.data.data.product_reviews[].pros_list`	`array`	No	—	Aggregated pros mentioned across reviews. Present only when products is provided.
`result.data.data.product_reviews[].cons_list`	`array`	No	—	Aggregated cons mentioned across reviews. Present only when products is provided.
`result.data.data.product_reviews[].pricing`	`array`	No	—	Pricing information for the product. Present only when products is provided.
`result.data.data.product_reviews[].reviews`	`object`	No	—	Reviews container. Present only when products is provided.
`result.data.data.product_reviews[].reviews.data`	`array`	No	—	—
`result.data.data.product_reviews[].reviews.data[].review_id`	`integer`	No	—	Unique identifier for the review.
`result.data.data.product_reviews[].reviews.data[].review_title`	`string`	No	—	Title of the review as submitted by the reviewer.
`result.data.data.product_reviews[].reviews.data[].review_content`	`string`	No	—	Full text of the review.
`result.data.data.product_reviews[].reviews.data[].review_question_answers`	`array`	No	—	Structured question-and-answer pairs from the review.
`result.data.data.product_reviews[].reviews.data[].review_question_answers[].question`	`string`	No	—	—
`result.data.data.product_reviews[].reviews.data[].review_question_answers[].answer`	`string`	No	—	—
`result.data.data.product_reviews[].reviews.data[].review_rating`	`number`	No	—	Rating given by the reviewer. Format: `float`.
`result.data.data.product_reviews[].reviews.data[].publish_date`	`string`	No	—	Publication date of the review in ISO 8601 format.
`result.data.data.product_reviews[].reviews.data[].reviewer_company_size`	`string`	No	—	Reviewer’s company size band.
`result.data.data.product_reviews[].reviews.data[].review_link`	`string`	No	—	Link to the original review on the provider’s site.
`result.data.data.product_reviews[].reviews.data[].provider`	`string`	No	—	Review provider identifier.
`result.data.data.product_reviews[].reviews.total`	`integer`	No	—	Total number of reviews available for the product across all providers.
`result.data.data.product_reviews[].reviews.total_by_provider`	`record`	No	—	Total review count broken down by provider.
`result.data.limit`	`integer`	No	—	—
`result.data.offset`	`integer`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.03 per pricing unit.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Akta: Product Reviews

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation