{
  "openapi": "3.0.1",
  "info": {
    "title": "Trustpilot Reviews Scraper — Ratings & Company Replies",
    "description": "Public Trustpilot review export. Collection is currently under maintenance because source access is restricted. Review history and successful collection are not currently confirmed. $0.50 per 1,000 delivered reviews plus a small start event.",
    "version": "2.4",
    "x-build-id": "xSjeEl99iFgMfP96t"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apivault_labs~trustpilot-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apivault_labs-trustpilot-reviews-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/apivault_labs~trustpilot-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-apivault_labs-trustpilot-reviews-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/apivault_labs~trustpilot-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-apivault_labs-trustpilot-reviews-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "companyUrls"
        ],
        "properties": {
          "companyUrls": {
            "title": "Companies to collect",
            "type": "array",
            "description": "1–100 company domains or Trustpilot /review/ URLs. Duplicates are removed.",
            "items": {
              "type": "string"
            }
          },
          "maxPages": {
            "title": "Pages per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many review pages to scrape per company (each page = ~20 reviews)",
            "default": 3
          },
          "maxReviews": {
            "title": "Maximum reviews per company",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum matching reviews per company. Zero removes the review limit; maxPages still applies.",
            "default": 50
          },
          "sortBy": {
            "title": "Sort reviews by",
            "enum": [
              "recency",
              "relevance"
            ],
            "type": "string",
            "description": "Order in which to fetch reviews",
            "default": "recency"
          },
          "filterStars": {
            "title": "Star ratings",
            "uniqueItems": true,
            "type": "array",
            "description": "Integer star ratings, for example [1, 2]. Empty array includes all ratings.",
            "default": []
          },
          "filterLanguages": {
            "title": "Languages",
            "type": "array",
            "description": "ISO 639-1 language codes, for example en, de, fr.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "filterCountries": {
            "title": "Reviewer countries",
            "type": "array",
            "description": "ISO country codes such as US, GB, DE. Applied after fetching.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "filterDateRange": {
            "title": "Date range",
            "enum": [
              "all",
              "last30days",
              "last3months",
              "last6months",
              "last12months"
            ],
            "type": "string",
            "description": "Publication-date window. Uses 30, 90, 180 or 365 days.",
            "default": "all"
          },
          "startDate": {
            "title": "Incremental cutoff date",
            "type": "string",
            "description": "Include reviews published on or after this YYYY-MM-DD date. Manual date cutoff; no automatic cross-run state reuse.",
            "default": ""
          },
          "verifiedOnly": {
            "title": "Verified reviews only",
            "type": "boolean",
            "description": "Require an explicit verified review flag. Unknown verification does not match.",
            "default": false
          },
          "repliesOnly": {
            "title": "Reviews with company replies only",
            "type": "boolean",
            "description": "Require a nonempty company reply.",
            "default": false
          },
          "includeCompanyDetails": {
            "title": "Save company profile",
            "type": "boolean",
            "description": "Save observed profiles in the free COMPANIES key-value record; profiles are not review rows.",
            "default": true
          },
          "includeRaw": {
            "title": "Include raw review object",
            "type": "boolean",
            "description": "Preserve the source review object alongside normalized fields. Raw content is independent of the selected field switches.",
            "default": false
          },
          "extractReviewer": {
            "title": "Reviewer Name",
            "type": "boolean",
            "description": "Include reviewer name",
            "default": true
          },
          "extractReviewerLocation": {
            "title": "Reviewer Location",
            "type": "boolean",
            "description": "Include reviewer country / location",
            "default": true
          },
          "extractReviewerTotalReviews": {
            "title": "Reviewer's Total Reviews",
            "type": "boolean",
            "description": "Total number of reviews written by this reviewer",
            "default": true
          },
          "extractTitle": {
            "title": "Review Title",
            "type": "boolean",
            "description": "Include the review headline",
            "default": true
          },
          "extractText": {
            "title": "Review Text",
            "type": "boolean",
            "description": "Include review body text",
            "default": true
          },
          "extractRating": {
            "title": "Rating",
            "type": "boolean",
            "description": "Star rating 1-5",
            "default": true
          },
          "extractDateOfExperience": {
            "title": "Date of Experience",
            "type": "boolean",
            "description": "Date the customer experienced the service",
            "default": true
          },
          "extractDatePublished": {
            "title": "Date Published",
            "type": "boolean",
            "description": "Date the review was posted on Trustpilot",
            "default": true
          },
          "extractVerified": {
            "title": "Verified Flag",
            "type": "boolean",
            "description": "Whether Trustpilot marked this review verified",
            "default": true
          },
          "extractOwnerReply": {
            "title": "Owner Reply",
            "type": "boolean",
            "description": "Company's response to the review, if any",
            "default": true
          },
          "extractCompanyName": {
            "title": "Company Name",
            "type": "boolean",
            "description": "Include the company domain on every review row",
            "default": true
          },
          "maxConcurrency": {
            "title": "Max Concurrency",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Companies collected concurrently. Pages within each company are read in sequence.",
            "default": 2
          },
          "maxRetries": {
            "title": "Maximum retries",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "Retry transient connection and server errors. Access denials are not retried.",
            "default": 1
          },
          "timeout": {
            "title": "Timeout per page (seconds)",
            "minimum": 10,
            "maximum": 180,
            "type": "integer",
            "description": "Max wait per Trustpilot page",
            "default": 45
          },
          "runBudgetSecs": {
            "title": "Collection time budget",
            "minimum": 20,
            "maximum": 900,
            "type": "integer",
            "description": "Stop requesting additional pages after this many seconds. An in-flight page may finish after the budget.",
            "default": 240
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}