> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Akta: Product Reviews
> Retrieving a company product catalog or detailed product reviews. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
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.
```ts theme={null}
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
```bash theme={null}
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.
```json theme={null}
{
"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. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "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.",
"properties": {
"company": {
"type": "string",
"description": "Company website (e.g. 'canva.com') or a company UUID. The UUID can be obtained from the Company Search API."
},
"products": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"limit": {
"type": "integer",
"description": "Maximum number of reviews to return per product. Only applies when products is provided.",
"default": 0,
"maximum": 50
},
"offset": {
"type": "integer",
"description": "Number of reviews to skip before returning records. Use with limit for pagination.",
"default": 0
}
},
"required": [
"company"
],
"additionalProperties": false
}
```
## 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). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"product_reviews": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the product. Use this value in the products query parameter to fetch reviews."
},
"product_name": {
"type": "string",
"description": "Display name of the product."
},
"main_category": {
"type": "string",
"description": "Primary category of the product."
},
"categories": {
"type": "array",
"description": "All categories the product belongs to.",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "Description of the product."
},
"rating": {
"type": "object",
"description": "Average rating per review provider. Keys are provider identifiers (e.g. g2) and values are floats. Present only when products is provided."
},
"star_distribution": {
"type": "object",
"description": "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": {
"type": "array",
"description": "Aggregated pros mentioned across reviews. Present only when products is provided.",
"items": {
"type": "string"
}
},
"cons_list": {
"type": "array",
"description": "Aggregated cons mentioned across reviews. Present only when products is provided.",
"items": {
"type": "string"
}
},
"pricing": {
"type": "array",
"description": "Pricing information for the product. Present only when products is provided.",
"items": {
"type": "object"
}
},
"reviews": {
"type": "object",
"description": "Reviews container. Present only when products is provided.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"review_id": {
"type": "integer",
"description": "Unique identifier for the review."
},
"review_title": {
"type": "string",
"description": "Title of the review as submitted by the reviewer."
},
"review_content": {
"type": "string",
"description": "Full text of the review."
},
"review_question_answers": {
"type": "array",
"description": "Structured question-and-answer pairs from the review.",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"answer": {
"type": "string"
}
},
"additionalProperties": false
}
},
"review_rating": {
"type": "number",
"description": "Rating given by the reviewer.",
"format": "float"
},
"publish_date": {
"type": "string",
"description": "Publication date of the review in ISO 8601 format."
},
"reviewer_company_size": {
"type": "string",
"description": "Reviewer's company size band."
},
"review_link": {
"type": "string",
"description": "Link to the original review on the provider's site."
},
"provider": {
"type": "string",
"description": "Review provider identifier."
}
},
"additionalProperties": false
}
},
"total": {
"type": "integer",
"description": "Total number of reviews available for the product across all providers."
},
"total_by_provider": {
"type": "object",
"description": "Total review count broken down by provider."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` per pricing unit.
## Related documentation
* [Akta provider guide](/docs/providers/akta/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)