
Results Checker
No credit card required

Results Checker
No credit card required
Check the results of your scrapers with this flexible checker. Just supply a dataset or key-value store ID and a few simple rules to get a detailed report.
You can access the Results Checker programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "8dft1caVyWKeTMyh4"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/lukaskrivka~results-checker/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-lukaskrivka-results-checker",
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/lukaskrivka~results-checker/runs": {
50 "post": {
51 "operationId": "runs-sync-lukaskrivka-results-checker",
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/lukaskrivka~results-checker/run-sync": {
93 "post": {
94 "operationId": "run-sync-lukaskrivka-results-checker",
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 "functionalChecker"
135 ],
136 "properties": {
137 "apifyStorageId": {
138 "title": "Apify Storage ID",
139 "type": "string",
140 "description": "Id of dataset or key value store where the data are located."
141 },
142 "recordKey": {
143 "title": "Record Key",
144 "type": "string",
145 "description": "Only specify if Apify storage id points to a key value store! This is the record key under which the data are."
146 },
147 "rawData": {
148 "title": "Raw Data",
149 "type": "array",
150 "description": "Raw JSON array you want to check."
151 },
152 "functionalChecker": {
153 "title": "Functional Checker",
154 "type": "string",
155 "description": "Function that returns an object with item fields as keys and values as predicates (functions that return true/false)"
156 },
157 "context": {
158 "title": "Context",
159 "type": "object",
160 "description": "Custom object where you can put any value that will be accessible in functional checker functions as **third** parameter. Useful for dynamic values coming from other actors."
161 },
162 "identificationFields": {
163 "title": "Identification Fields",
164 "type": "array",
165 "description": "You can specify which fields should display in the debug OUTPUT to identify bad items. By default it shows all fields which may make it unnecessary big."
166 },
167 "minimalSuccessRate": {
168 "title": "Minimal success rate",
169 "type": "object",
170 "description": "You can specify minimal success rate (0 to 1) of any field. If the success rate will be higher than this, the field will not be count as bad field. This needs t obe an object with fields as keys and success rate as values."
171 },
172 "noExtraFields": {
173 "title": "No extra fields",
174 "type": "boolean",
175 "description": "If checked on, the actor will consider extra fields as bad fields. Uncheck if you don't mind them",
176 "default": true
177 },
178 "limit": {
179 "title": "Limit",
180 "minimum": 1,
181 "type": "integer",
182 "description": "How many items will be checked. Default is all"
183 },
184 "offset": {
185 "title": "Offset",
186 "minimum": 1,
187 "type": "integer",
188 "description": "From which item the checking will start. Use with limit to check specific items."
189 },
190 "batchSize": {
191 "title": "Batch Size",
192 "minimum": 1,
193 "type": "integer",
194 "description": "You can change number of loaded and processed items in each batch. This is only needed if you have really huge items.",
195 "default": 50000
196 },
197 "maxBadItemsSaved": {
198 "title": "Max bad items saved",
199 "minimum": 0,
200 "type": "integer",
201 "description": "Sets how big report you get for each unique combination of bad fields. Keeping this small and running it again after fixing some is the best approach. It speeds up the actor and reduces memory need.",
202 "default": 20
203 }
204 }
205 },
206 "runsResponseSchema": {
207 "type": "object",
208 "properties": {
209 "data": {
210 "type": "object",
211 "properties": {
212 "id": {
213 "type": "string"
214 },
215 "actId": {
216 "type": "string"
217 },
218 "userId": {
219 "type": "string"
220 },
221 "startedAt": {
222 "type": "string",
223 "format": "date-time",
224 "example": "2025-01-08T00:00:00.000Z"
225 },
226 "finishedAt": {
227 "type": "string",
228 "format": "date-time",
229 "example": "2025-01-08T00:00:00.000Z"
230 },
231 "status": {
232 "type": "string",
233 "example": "READY"
234 },
235 "meta": {
236 "type": "object",
237 "properties": {
238 "origin": {
239 "type": "string",
240 "example": "API"
241 },
242 "userAgent": {
243 "type": "string"
244 }
245 }
246 },
247 "stats": {
248 "type": "object",
249 "properties": {
250 "inputBodyLen": {
251 "type": "integer",
252 "example": 2000
253 },
254 "rebootCount": {
255 "type": "integer",
256 "example": 0
257 },
258 "restartCount": {
259 "type": "integer",
260 "example": 0
261 },
262 "resurrectCount": {
263 "type": "integer",
264 "example": 0
265 },
266 "computeUnits": {
267 "type": "integer",
268 "example": 0
269 }
270 }
271 },
272 "options": {
273 "type": "object",
274 "properties": {
275 "build": {
276 "type": "string",
277 "example": "latest"
278 },
279 "timeoutSecs": {
280 "type": "integer",
281 "example": 300
282 },
283 "memoryMbytes": {
284 "type": "integer",
285 "example": 1024
286 },
287 "diskMbytes": {
288 "type": "integer",
289 "example": 2048
290 }
291 }
292 },
293 "buildId": {
294 "type": "string"
295 },
296 "defaultKeyValueStoreId": {
297 "type": "string"
298 },
299 "defaultDatasetId": {
300 "type": "string"
301 },
302 "defaultRequestQueueId": {
303 "type": "string"
304 },
305 "buildNumber": {
306 "type": "string",
307 "example": "1.0.0"
308 },
309 "containerUrl": {
310 "type": "string"
311 },
312 "usage": {
313 "type": "object",
314 "properties": {
315 "ACTOR_COMPUTE_UNITS": {
316 "type": "integer",
317 "example": 0
318 },
319 "DATASET_READS": {
320 "type": "integer",
321 "example": 0
322 },
323 "DATASET_WRITES": {
324 "type": "integer",
325 "example": 0
326 },
327 "KEY_VALUE_STORE_READS": {
328 "type": "integer",
329 "example": 0
330 },
331 "KEY_VALUE_STORE_WRITES": {
332 "type": "integer",
333 "example": 1
334 },
335 "KEY_VALUE_STORE_LISTS": {
336 "type": "integer",
337 "example": 0
338 },
339 "REQUEST_QUEUE_READS": {
340 "type": "integer",
341 "example": 0
342 },
343 "REQUEST_QUEUE_WRITES": {
344 "type": "integer",
345 "example": 0
346 },
347 "DATA_TRANSFER_INTERNAL_GBYTES": {
348 "type": "integer",
349 "example": 0
350 },
351 "DATA_TRANSFER_EXTERNAL_GBYTES": {
352 "type": "integer",
353 "example": 0
354 },
355 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
356 "type": "integer",
357 "example": 0
358 },
359 "PROXY_SERPS": {
360 "type": "integer",
361 "example": 0
362 }
363 }
364 },
365 "usageTotalUsd": {
366 "type": "number",
367 "example": 0.00005
368 },
369 "usageUsd": {
370 "type": "object",
371 "properties": {
372 "ACTOR_COMPUTE_UNITS": {
373 "type": "integer",
374 "example": 0
375 },
376 "DATASET_READS": {
377 "type": "integer",
378 "example": 0
379 },
380 "DATASET_WRITES": {
381 "type": "integer",
382 "example": 0
383 },
384 "KEY_VALUE_STORE_READS": {
385 "type": "integer",
386 "example": 0
387 },
388 "KEY_VALUE_STORE_WRITES": {
389 "type": "number",
390 "example": 0.00005
391 },
392 "KEY_VALUE_STORE_LISTS": {
393 "type": "integer",
394 "example": 0
395 },
396 "REQUEST_QUEUE_READS": {
397 "type": "integer",
398 "example": 0
399 },
400 "REQUEST_QUEUE_WRITES": {
401 "type": "integer",
402 "example": 0
403 },
404 "DATA_TRANSFER_INTERNAL_GBYTES": {
405 "type": "integer",
406 "example": 0
407 },
408 "DATA_TRANSFER_EXTERNAL_GBYTES": {
409 "type": "integer",
410 "example": 0
411 },
412 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
413 "type": "integer",
414 "example": 0
415 },
416 "PROXY_SERPS": {
417 "type": "integer",
418 "example": 0
419 }
420 }
421 }
422 }
423 }
424 }
425 }
426 }
427 }
428}
Results Checker OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Results Checker from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Actor Metrics
1 monthly user
-
8 bookmarks
Created in May 2019
Modified 4 years ago