> ## 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: Employee Reviews
> Retrieving aggregated employee sentiment and individual workplace reviews. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.
Retrieving aggregated employee sentiment and individual workplace reviews.
Tool ID: `akta_employee_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_employee_reviews',
{
"company": "Example Corp"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute akta_employee_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",
"employee_reviews": {
"overall_rating": {},
"other_ratings": [
{}
],
"reviews": {
"total": 123,
"total_by_provider": {}
}
}
},
"limit": 123,
"offset": 123
}
}
```
Use `deepline tools get akta_employee_reviews --json` for the latest machine-readable contract.
## Input reference
Fetch a company's employee review data including overall ratings, dimension-level ratings (culture, work-life balance, senior management and more) and individual employee reviews. 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.limit` | `integer` | No | `10` | Maximum number of reviews to return. Maximum: 100. |
| `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": "Fetch a company's employee review data including overall ratings, dimension-level ratings (culture, work-life balance, senior management and more) and individual employee reviews. 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."
},
"limit": {
"type": "integer",
"description": "Maximum number of reviews to return.",
"default": 10,
"maximum": 100
},
"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 | — | Company UUID. |
| `result.data.data.employee_reviews` | `object` | No | — | — |
| `result.data.data.employee_reviews.overall_rating` | `record` | No | — | Overall company rating per review provider. Keys are provider identifiers (e.g. glassdoor), values are floats. |
| `result.data.data.employee_reviews.other_ratings` | `array` | No | — | Dimension-level ratings broken out per provider. |
| `result.data.data.employee_reviews.other_ratings[].type` | `string` | No | — | Rating dimension. Example: business\_outlook, ceo, recommend\_to\_friend, compensation\_and\_benefits, culture\_and\_values, diversity\_and\_inclusion, senior\_management, work\_life\_balance. |
| `result.data.data.employee_reviews.other_ratings[].provider` | `string` | No | — | Review provider identifier. |
| `result.data.data.employee_reviews.other_ratings[].value` | `number` | No | — | Rating value. Sentiment-style dimensions (business\_outlook, ceo, recommend\_to\_friend) are 0 to 1 percentage; other dimensions are 0 to 5 scale. |
| `result.data.data.employee_reviews.reviews` | `object` | No | — | — |
| `result.data.data.employee_reviews.reviews.data` | `array` | No | — | — |
| `result.data.data.employee_reviews.reviews.data[].id` | `integer` | No | — | Unique identifier for the review. |
| `result.data.data.employee_reviews.reviews.data[].summary` | `string` | No | — | Review headline or summary. |
| `result.data.data.employee_reviews.reviews.data[].pros` | `string` | No | — | Pros described by the reviewer. |
| `result.data.data.employee_reviews.reviews.data[].cons` | `string` | No | — | Cons described by the reviewer. |
| `result.data.data.employee_reviews.reviews.data[].rating` | `integer` | No | — | Overall star rating given by the reviewer. |
| `result.data.data.employee_reviews.reviews.data[].review_link` | `string` | No | — | Link to the original review on the provider's site. |
| `result.data.data.employee_reviews.reviews.data[].job_title` | `string` | No | — | Job title of the reviewer. |
| `result.data.data.employee_reviews.reviews.data[].review_date` | `string` | No | — | Publication date of the review. |
| `result.data.data.employee_reviews.reviews.data[].employment_status` | `string` | No | — | Employment type of the reviewer. Example: REGULAR, CONTRACT. |
| `result.data.data.employee_reviews.reviews.data[].is_current_employee` | `boolean` | No | — | True if the reviewer was a current employee at the time of writing. |
| `result.data.data.employee_reviews.reviews.data[].years_of_employment` | `integer` | No | — | Reviewer's tenure at the company in years. |
| `result.data.data.employee_reviews.reviews.data[].location` | `string` | No | — | Location of the reviewer. |
| `result.data.data.employee_reviews.reviews.data[].country_code` | `string` | No | — | Country code of the reviewer's location. |
| `result.data.data.employee_reviews.reviews.data[].helpful_count` | `integer` | No | — | Number of users who marked the review as helpful. |
| `result.data.data.employee_reviews.reviews.data[].not_helpful_count` | `integer` | No | — | Number of users who marked the review as not helpful. |
| `result.data.data.employee_reviews.reviews.data[].career_opportunities_rating` | `integer` | No | — | Reviewer's rating for career opportunities. |
| `result.data.data.employee_reviews.reviews.data[].ceo_rating` | `string` | No | — | Reviewer's CEO sentiment. Example: APPROVE, DISAPPROVE. |
| `result.data.data.employee_reviews.reviews.data[].compensation_and_benefits_rating` | `integer` | No | — | Reviewer's rating for compensation and benefits. |
| `result.data.data.employee_reviews.reviews.data[].culture_and_values_rating` | `integer` | No | — | Reviewer's rating for culture and values. |
| `result.data.data.employee_reviews.reviews.data[].diversity_and_inclusion_rating` | `integer` | No | — | Reviewer's rating for diversity and inclusion. |
| `result.data.data.employee_reviews.reviews.data[].senior_management_rating` | `integer` | No | — | Reviewer's rating for senior management. |
| `result.data.data.employee_reviews.reviews.data[].work_life_balance_rating` | `integer` | No | — | Reviewer's rating for work-life balance. |
| `result.data.data.employee_reviews.reviews.data[].language` | `string` | No | — | Language code of the review. |
| `result.data.data.employee_reviews.reviews.data[].provider` | `string` | No | — | Review provider identifier. |
| `result.data.data.employee_reviews.reviews.total` | `integer` | No | — | Total number of reviews available for the company across all providers. |
| `result.data.data.employee_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",
"description": "Company UUID."
},
"employee_reviews": {
"type": "object",
"properties": {
"overall_rating": {
"type": "object",
"description": "Overall company rating per review provider. Keys are provider identifiers (e.g. glassdoor), values are floats."
},
"other_ratings": {
"type": "array",
"description": "Dimension-level ratings broken out per provider.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Rating dimension. Example: business_outlook, ceo, recommend_to_friend, compensation_and_benefits, culture_and_values, diversity_and_inclusion, senior_management, work_life_balance."
},
"provider": {
"type": "string",
"description": "Review provider identifier."
},
"value": {
"type": "number",
"description": "Rating value. Sentiment-style dimensions (business_outlook, ceo, recommend_to_friend) are 0 to 1 percentage; other dimensions are 0 to 5 scale."
}
},
"additionalProperties": false
}
},
"reviews": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the review."
},
"summary": {
"type": "string",
"description": "Review headline or summary."
},
"pros": {
"type": "string",
"description": "Pros described by the reviewer."
},
"cons": {
"type": "string",
"description": "Cons described by the reviewer."
},
"rating": {
"type": "integer",
"description": "Overall star rating given by the reviewer."
},
"review_link": {
"type": "string",
"description": "Link to the original review on the provider's site."
},
"job_title": {
"type": "string",
"description": "Job title of the reviewer."
},
"review_date": {
"type": "string",
"description": "Publication date of the review."
},
"employment_status": {
"type": "string",
"description": "Employment type of the reviewer. Example: REGULAR, CONTRACT."
},
"is_current_employee": {
"type": "boolean",
"description": "True if the reviewer was a current employee at the time of writing."
},
"years_of_employment": {
"type": "integer",
"description": "Reviewer's tenure at the company in years."
},
"location": {
"type": "string",
"description": "Location of the reviewer."
},
"country_code": {
"type": "string",
"description": "Country code of the reviewer's location."
},
"helpful_count": {
"type": "integer",
"description": "Number of users who marked the review as helpful."
},
"not_helpful_count": {
"type": "integer",
"description": "Number of users who marked the review as not helpful."
},
"career_opportunities_rating": {
"type": "integer",
"description": "Reviewer's rating for career opportunities."
},
"ceo_rating": {
"type": "string",
"description": "Reviewer's CEO sentiment. Example: APPROVE, DISAPPROVE."
},
"compensation_and_benefits_rating": {
"type": "integer",
"description": "Reviewer's rating for compensation and benefits."
},
"culture_and_values_rating": {
"type": "integer",
"description": "Reviewer's rating for culture and values."
},
"diversity_and_inclusion_rating": {
"type": "integer",
"description": "Reviewer's rating for diversity and inclusion."
},
"senior_management_rating": {
"type": "integer",
"description": "Reviewer's rating for senior management."
},
"work_life_balance_rating": {
"type": "integer",
"description": "Reviewer's rating for work-life balance."
},
"language": {
"type": "string",
"description": "Language code of the review."
},
"provider": {
"type": "string",
"description": "Review provider identifier."
}
},
"additionalProperties": false
}
},
"total": {
"type": "integer",
"description": "Total number of reviews available for the company 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)