Monitoring Runner
Pricing
Pay per usage
Go to Store
Monitoring Runner
apify/monitoring-runner
The monitoring runner is a part of the Apify Monitoring Suite (apify/monitoring). See its readme for more information and how to use this.
4.5 (2)
Pricing
Pay per usage
16
Monthly users
37
Runs succeeded
98%
Last modified
9 months ago
You can access the Monitoring Runner programmatically from your own applications by using the Apify API. You can also 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": "NsoMmOtydmedVKZXR"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/apify~monitoring-runner/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-apify-monitoring-runner",
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/apify~monitoring-runner/runs": {
50 "post": {
51 "operationId": "runs-sync-apify-monitoring-runner",
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/apify~monitoring-runner/run-sync": {
93 "post": {
94 "operationId": "run-sync-apify-monitoring-runner",
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 "targetType"
135 ],
136 "properties": {
137 "projectName": {
138 "title": "Monitoring suite name",
139 "pattern": "^([a-zA-Z0-9!\\-_.'()]{1,15})$",
140 "maxLength": 15,
141 "type": "string",
142 "description": "Name of your monitoring suite. It will be used in notifications and to identify related resources in the Apify dashboard."
143 },
144 "targetType": {
145 "title": "Type of target",
146 "enum": [
147 "ACTOR",
148 "TASK",
149 "NAMED_DATASET"
150 ],
151 "type": "string",
152 "description": "Only one type of target can be monitored by a single monitoring suite. If you want to watch more types, create more monitoring suites.",
153 "default": "ACTOR"
154 },
155 "targetPatternList": {
156 "title": "Target name patterns",
157 "type": "array",
158 "description": "Regular expressions that will be matched against selected actors / tasks or datasets under your Apify account. All matching targets will then be monitored by this monitoring suite. This is typically also the fastest way to select a single target. Just type its full name. Datasets are going to be automatically group by these patterns when dashboard statistics is counted for dataset target type.",
159 "default": [],
160 "items": {
161 "type": "string"
162 }
163 },
164 "targetList": {
165 "title": "Target IDs",
166 "type": "array",
167 "description": "If for whatever reason the Target name pattern option does not suit you, targets can also be specified by providing their IDs, as found in your Apify dashboard.",
168 "default": [],
169 "items": {
170 "type": "string"
171 }
172 },
173 "limit": {
174 "title": "Max items to be checked",
175 "minimum": 1,
176 "maximum": 1000,
177 "type": "integer",
178 "description": "Last items to be checked. If 100 is passed, only last hundred runs/datasets will be checked. ",
179 "default": 1000
180 },
181 "saveHistory": {
182 "title": "Save history",
183 "type": "boolean",
184 "description": "All monitoring runs results are saved in named dataset",
185 "default": false
186 },
187 "resourceStatsCollector": {
188 "title": "Resource stats collector",
189 "type": "boolean",
190 "description": "Works with Subject type 'Actor', 'Task' and 'Named dateaset', Gets information about the runs TODO: LINK TO PA"
191 },
192 "duplicationChecker": {
193 "title": "Duplication checker",
194 "type": "boolean",
195 "description": "Checks for duplicates based on defined unique fields. Based on 'https://apify.com/lukaskrivka/duplications-checker'"
196 },
197 "schemaValidatorChecker": {
198 "title": "Schema validator checker",
199 "type": "boolean",
200 "description": "Validates dataset items based on the Type check library"
201 },
202 "runStatusChecker": {
203 "title": "Run status validator",
204 "type": "boolean",
205 "description": "Validates run status"
206 },
207 "checkers": {
208 "title": "Checkers",
209 "uniqueItems": true,
210 "type": "array",
211 "description": "Ids of checker actors or tasks that needs",
212 "default": [],
213 "items": {
214 "type": "string"
215 }
216 },
217 "checkersInput": {
218 "title": "Checkers input",
219 "type": "object",
220 "description": "Pass input to checkers"
221 },
222 "dashboard": {
223 "title": "Dashboard",
224 "type": "boolean",
225 "description": "Works with Subject type 'Actor', 'Task' 'Named dataset'. Starts dashboard actor. LINK TO PA"
226 },
227 "emailReporter": {
228 "title": "Email",
229 "type": "boolean",
230 "description": "Sends report to mail inbox. LINK TO PA for input"
231 },
232 "slackReporter": {
233 "title": "Slack",
234 "type": "boolean",
235 "description": "Sends report to custom slack channel. LINK TO PA for input"
236 },
237 "reporters": {
238 "title": "Reporters",
239 "uniqueItems": true,
240 "type": "array",
241 "description": "Id of reporter actors or tasks",
242 "default": [],
243 "items": {
244 "type": "string"
245 }
246 },
247 "reportersInput": {
248 "title": "Checkers input",
249 "type": "object",
250 "description": "Pass input to checkers"
251 },
252 "frequency": {
253 "title": "The frequency of task",
254 "type": "string",
255 "description": "If passed the resources will be filtered by the frequency of the task. For example if you pass MONTHLY only resources modified last month will be collected."
256 }
257 }
258 },
259 "runsResponseSchema": {
260 "type": "object",
261 "properties": {
262 "data": {
263 "type": "object",
264 "properties": {
265 "id": {
266 "type": "string"
267 },
268 "actId": {
269 "type": "string"
270 },
271 "userId": {
272 "type": "string"
273 },
274 "startedAt": {
275 "type": "string",
276 "format": "date-time",
277 "example": "2025-01-08T00:00:00.000Z"
278 },
279 "finishedAt": {
280 "type": "string",
281 "format": "date-time",
282 "example": "2025-01-08T00:00:00.000Z"
283 },
284 "status": {
285 "type": "string",
286 "example": "READY"
287 },
288 "meta": {
289 "type": "object",
290 "properties": {
291 "origin": {
292 "type": "string",
293 "example": "API"
294 },
295 "userAgent": {
296 "type": "string"
297 }
298 }
299 },
300 "stats": {
301 "type": "object",
302 "properties": {
303 "inputBodyLen": {
304 "type": "integer",
305 "example": 2000
306 },
307 "rebootCount": {
308 "type": "integer",
309 "example": 0
310 },
311 "restartCount": {
312 "type": "integer",
313 "example": 0
314 },
315 "resurrectCount": {
316 "type": "integer",
317 "example": 0
318 },
319 "computeUnits": {
320 "type": "integer",
321 "example": 0
322 }
323 }
324 },
325 "options": {
326 "type": "object",
327 "properties": {
328 "build": {
329 "type": "string",
330 "example": "latest"
331 },
332 "timeoutSecs": {
333 "type": "integer",
334 "example": 300
335 },
336 "memoryMbytes": {
337 "type": "integer",
338 "example": 1024
339 },
340 "diskMbytes": {
341 "type": "integer",
342 "example": 2048
343 }
344 }
345 },
346 "buildId": {
347 "type": "string"
348 },
349 "defaultKeyValueStoreId": {
350 "type": "string"
351 },
352 "defaultDatasetId": {
353 "type": "string"
354 },
355 "defaultRequestQueueId": {
356 "type": "string"
357 },
358 "buildNumber": {
359 "type": "string",
360 "example": "1.0.0"
361 },
362 "containerUrl": {
363 "type": "string"
364 },
365 "usage": {
366 "type": "object",
367 "properties": {
368 "ACTOR_COMPUTE_UNITS": {
369 "type": "integer",
370 "example": 0
371 },
372 "DATASET_READS": {
373 "type": "integer",
374 "example": 0
375 },
376 "DATASET_WRITES": {
377 "type": "integer",
378 "example": 0
379 },
380 "KEY_VALUE_STORE_READS": {
381 "type": "integer",
382 "example": 0
383 },
384 "KEY_VALUE_STORE_WRITES": {
385 "type": "integer",
386 "example": 1
387 },
388 "KEY_VALUE_STORE_LISTS": {
389 "type": "integer",
390 "example": 0
391 },
392 "REQUEST_QUEUE_READS": {
393 "type": "integer",
394 "example": 0
395 },
396 "REQUEST_QUEUE_WRITES": {
397 "type": "integer",
398 "example": 0
399 },
400 "DATA_TRANSFER_INTERNAL_GBYTES": {
401 "type": "integer",
402 "example": 0
403 },
404 "DATA_TRANSFER_EXTERNAL_GBYTES": {
405 "type": "integer",
406 "example": 0
407 },
408 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
409 "type": "integer",
410 "example": 0
411 },
412 "PROXY_SERPS": {
413 "type": "integer",
414 "example": 0
415 }
416 }
417 },
418 "usageTotalUsd": {
419 "type": "number",
420 "example": 0.00005
421 },
422 "usageUsd": {
423 "type": "object",
424 "properties": {
425 "ACTOR_COMPUTE_UNITS": {
426 "type": "integer",
427 "example": 0
428 },
429 "DATASET_READS": {
430 "type": "integer",
431 "example": 0
432 },
433 "DATASET_WRITES": {
434 "type": "integer",
435 "example": 0
436 },
437 "KEY_VALUE_STORE_READS": {
438 "type": "integer",
439 "example": 0
440 },
441 "KEY_VALUE_STORE_WRITES": {
442 "type": "number",
443 "example": 0.00005
444 },
445 "KEY_VALUE_STORE_LISTS": {
446 "type": "integer",
447 "example": 0
448 },
449 "REQUEST_QUEUE_READS": {
450 "type": "integer",
451 "example": 0
452 },
453 "REQUEST_QUEUE_WRITES": {
454 "type": "integer",
455 "example": 0
456 },
457 "DATA_TRANSFER_INTERNAL_GBYTES": {
458 "type": "integer",
459 "example": 0
460 },
461 "DATA_TRANSFER_EXTERNAL_GBYTES": {
462 "type": "integer",
463 "example": 0
464 },
465 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
466 "type": "integer",
467 "example": 0
468 },
469 "PROXY_SERPS": {
470 "type": "integer",
471 "example": 0
472 }
473 }
474 }
475 }
476 }
477 }
478 }
479 }
480 }
481}Monitoring Runner 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 Monitoring Runner 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:
Pricing
Pricing model
Pay per usageThis Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage.
