openapi: 3.2.0
info:
  title: Akta Pro Reviews API
  version: 1.0.0
  contact:
    url: https://akta.pro
  description: 'Operations tagged Reviews across 2 of this provider''s published API definitions: akta-pro-docs-openapi.json, akta-pro-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.akta.pro/api
  description: Production server
tags:
- name: Reviews
  description: Product and employee reviews from external sources
paths:
  /v1/company/product-reviews:
    get:
      tags:
      - Reviews
      operationId: getProductReviews
      summary: Product Reviews
      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.'
      security:
      - xApiKeyAuth: []
      parameters:
      - name: company
        in: query
        required: true
        schema:
          type: string
        description: Company website (e.g. 'canva.com') or a company UUID. The UUID can be obtained from the Company Search API.
      - name: products
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        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.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 0
          maximum: 50
        description: Maximum number of reviews to return per product. Only applies when products is provided.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
        description: Number of reviews to skip before returning records. Use with limit for pagination.
      responses:
        '200':
          description: Product reviews returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      uuid:
                        type: string
                      product_reviews:
                        type: array
                        items:
                          $ref: '#/components/schemas/ProductReview'
                  limit:
                    type: integer
                  offset:
                    type: integer
                  credits_consumed:
                    type: number
                    format: float
        '401':
          description: Unauthorized — missing or invalid API key.
    servers:
    - url: https://api.akta.pro/api
      description: Production server
  /v1/company/employee-reviews:
    get:
      tags:
      - Reviews
      operationId: getEmployeeReviews
      summary: Employee Reviews
      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.'
      security:
      - xApiKeyAuth: []
      parameters:
      - name: company
        in: query
        required: true
        schema:
          type: string
        description: Company website (e.g. 'canva.com') or a company UUID. The UUID can be obtained from the Company Search API.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 10
          maximum: 100
        description: Maximum number of reviews to return.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
        description: Number of reviews to skip before returning records. Use with limit for pagination.
      responses:
        '200':
          description: Employee reviews returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EmployeeReview'
                  limit:
                    type: integer
                  offset:
                    type: integer
                  credits_consumed:
                    type: number
                    format: float
        '401':
          description: Unauthorized — missing or invalid API key.
    servers:
    - url: https://api.akta.pro/api
      description: Production server
components:
  schemas:
    EmployeeReview:
      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
              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.
              description: Dimension-level ratings broken out per provider.
            reviews:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/EmployeeReviewItem'
                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.
    ProductReview:
      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
          items:
            type: string
          description: All categories the product belongs to.
        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
          items:
            type: string
          description: Aggregated pros mentioned across reviews. Present only when products is provided.
        cons_list:
          type: array
          items:
            type: string
          description: Aggregated cons mentioned across reviews. Present only when products is provided.
        pricing:
          type: array
          items:
            type: object
          description: Pricing information for the product. Present only when products is provided.
        reviews:
          type: object
          description: Reviews container. Present only when products is provided.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/ProductReviewItem'
            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.
    EmployeeReviewItem:
      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.
    ProductReviewItem:
      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
          items:
            type: object
            properties:
              question:
                type: string
              answer:
                type: string
          description: Structured question-and-answer pairs from the review.
        review_rating:
          type: number
          format: float
          description: Rating given by the reviewer.
        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.
  securitySchemes:
    xApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key obtained from your Akta account.
externalDocs:
  description: Official Akta.pro API Documentation
  url: https://docs.akta.pro
x-refined-from:
- akta-pro-docs-openapi.json
- akta-pro-openapi.yml