Trustpilot reviews scraper

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "2.1",
5    "x-build-id": "0QxQUM4BZmkTkVToN"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/casper11515~trustpilot-reviews-scraper/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-casper11515-trustpilot-reviews-scraper",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/casper11515~trustpilot-reviews-scraper/runs": {
50      "post": {
51        "operationId": "runs-sync-casper11515-trustpilot-reviews-scraper",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/casper11515~trustpilot-reviews-scraper/run-sync": {
93      "post": {
94        "operationId": "run-sync-casper11515-trustpilot-reviews-scraper",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "companyWebsite"
135        ],
136        "properties": {
137          "companyWebsite": {
138            "title": "company website to scrape reviews for",
139            "type": "string",
140            "description": "The list of company websites."
141          },
142          "onlyExtractCompanyInformation": {
143            "title": "Only extract company information",
144            "type": "string",
145            "description": "If checked, the scraper will only extract company information and not reviews",
146            "default": "false"
147          },
148          "sortBy": {
149            "title": "sorting",
150            "type": "string",
151            "description": "sort by recency or relevancy (don't enter something)",
152            "default": "recency"
153          },
154          "filterByStarRating": {
155            "title": "Filter by stars",
156            "type": "string",
157            "description": "Filter by 1,2,3,4,5 stars. Can not be combined",
158            "default": ""
159          },
160          "filterByLanguage": {
161            "title": "Filter by language",
162            "type": "string",
163            "description": "Filter by language eg da, de, es and so on. Can not be combined",
164            "default": "all"
165          },
166          "filterByVerified": {
167            "title": "Filter by verified",
168            "type": "string",
169            "description": "Filter by if review is verified. Type yes to filter by only verified reviews",
170            "default": ""
171          },
172          "filterByCountryOfReviewers": {
173            "title": "Filter by country of reviewers",
174            "type": "string",
175            "description": "Filter by if review was written by reviewers in a specific country. A list of country codes can be found here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, only 1 country code can be used at a time",
176            "default": ""
177          },
178          "startFromPageNumber": {
179            "title": "Page to start scraping from",
180            "minimum": 1,
181            "type": "integer",
182            "description": "You can specify the page number (eg. 7) that the scraper should start from. If this is left blank it will scrape from page 1",
183            "default": 1
184          },
185          "endAtPageNumber": {
186            "title": "Page to scrape last",
187            "type": "integer",
188            "description": "You can specify the page number (eg. 9) that the scraper should scrape last. If this is left set to 0 it will continue scraping to and including the last page",
189            "default": 1
190          },
191          "Proxy configuration": {
192            "title": "Select proxies to be used by your crawler",
193            "type": "object",
194            "description": "Select Apify proxies or set your own proxies"
195          }
196        }
197      },
198      "runsResponseSchema": {
199        "type": "object",
200        "properties": {
201          "data": {
202            "type": "object",
203            "properties": {
204              "id": {
205                "type": "string"
206              },
207              "actId": {
208                "type": "string"
209              },
210              "userId": {
211                "type": "string"
212              },
213              "startedAt": {
214                "type": "string",
215                "format": "date-time",
216                "example": "2025-01-08T00:00:00.000Z"
217              },
218              "finishedAt": {
219                "type": "string",
220                "format": "date-time",
221                "example": "2025-01-08T00:00:00.000Z"
222              },
223              "status": {
224                "type": "string",
225                "example": "READY"
226              },
227              "meta": {
228                "type": "object",
229                "properties": {
230                  "origin": {
231                    "type": "string",
232                    "example": "API"
233                  },
234                  "userAgent": {
235                    "type": "string"
236                  }
237                }
238              },
239              "stats": {
240                "type": "object",
241                "properties": {
242                  "inputBodyLen": {
243                    "type": "integer",
244                    "example": 2000
245                  },
246                  "rebootCount": {
247                    "type": "integer",
248                    "example": 0
249                  },
250                  "restartCount": {
251                    "type": "integer",
252                    "example": 0
253                  },
254                  "resurrectCount": {
255                    "type": "integer",
256                    "example": 0
257                  },
258                  "computeUnits": {
259                    "type": "integer",
260                    "example": 0
261                  }
262                }
263              },
264              "options": {
265                "type": "object",
266                "properties": {
267                  "build": {
268                    "type": "string",
269                    "example": "latest"
270                  },
271                  "timeoutSecs": {
272                    "type": "integer",
273                    "example": 300
274                  },
275                  "memoryMbytes": {
276                    "type": "integer",
277                    "example": 1024
278                  },
279                  "diskMbytes": {
280                    "type": "integer",
281                    "example": 2048
282                  }
283                }
284              },
285              "buildId": {
286                "type": "string"
287              },
288              "defaultKeyValueStoreId": {
289                "type": "string"
290              },
291              "defaultDatasetId": {
292                "type": "string"
293              },
294              "defaultRequestQueueId": {
295                "type": "string"
296              },
297              "buildNumber": {
298                "type": "string",
299                "example": "1.0.0"
300              },
301              "containerUrl": {
302                "type": "string"
303              },
304              "usage": {
305                "type": "object",
306                "properties": {
307                  "ACTOR_COMPUTE_UNITS": {
308                    "type": "integer",
309                    "example": 0
310                  },
311                  "DATASET_READS": {
312                    "type": "integer",
313                    "example": 0
314                  },
315                  "DATASET_WRITES": {
316                    "type": "integer",
317                    "example": 0
318                  },
319                  "KEY_VALUE_STORE_READS": {
320                    "type": "integer",
321                    "example": 0
322                  },
323                  "KEY_VALUE_STORE_WRITES": {
324                    "type": "integer",
325                    "example": 1
326                  },
327                  "KEY_VALUE_STORE_LISTS": {
328                    "type": "integer",
329                    "example": 0
330                  },
331                  "REQUEST_QUEUE_READS": {
332                    "type": "integer",
333                    "example": 0
334                  },
335                  "REQUEST_QUEUE_WRITES": {
336                    "type": "integer",
337                    "example": 0
338                  },
339                  "DATA_TRANSFER_INTERNAL_GBYTES": {
340                    "type": "integer",
341                    "example": 0
342                  },
343                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
344                    "type": "integer",
345                    "example": 0
346                  },
347                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
348                    "type": "integer",
349                    "example": 0
350                  },
351                  "PROXY_SERPS": {
352                    "type": "integer",
353                    "example": 0
354                  }
355                }
356              },
357              "usageTotalUsd": {
358                "type": "number",
359                "example": 0.00005
360              },
361              "usageUsd": {
362                "type": "object",
363                "properties": {
364                  "ACTOR_COMPUTE_UNITS": {
365                    "type": "integer",
366                    "example": 0
367                  },
368                  "DATASET_READS": {
369                    "type": "integer",
370                    "example": 0
371                  },
372                  "DATASET_WRITES": {
373                    "type": "integer",
374                    "example": 0
375                  },
376                  "KEY_VALUE_STORE_READS": {
377                    "type": "integer",
378                    "example": 0
379                  },
380                  "KEY_VALUE_STORE_WRITES": {
381                    "type": "number",
382                    "example": 0.00005
383                  },
384                  "KEY_VALUE_STORE_LISTS": {
385                    "type": "integer",
386                    "example": 0
387                  },
388                  "REQUEST_QUEUE_READS": {
389                    "type": "integer",
390                    "example": 0
391                  },
392                  "REQUEST_QUEUE_WRITES": {
393                    "type": "integer",
394                    "example": 0
395                  },
396                  "DATA_TRANSFER_INTERNAL_GBYTES": {
397                    "type": "integer",
398                    "example": 0
399                  },
400                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
401                    "type": "integer",
402                    "example": 0
403                  },
404                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
405                    "type": "integer",
406                    "example": 0
407                  },
408                  "PROXY_SERPS": {
409                    "type": "integer",
410                    "example": 0
411                  }
412                }
413              }
414            }
415          }
416        }
417      }
418    }
419  }
420}