Monitoring Checker Schema
Pricing
Pay per usage
Go to Store
Monitoring Checker Schema
The monitoring checker schema is a part of the Apify Monitoring Suite (apify/monitoring). See its readme for more information and how to use this.
4.8 (5)
Pricing
Pay per usage
8
Monthly users
8
Runs succeeded
>99%
Last modified
10 months ago
You can access the Monitoring Checker Schema 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": "pfHL9xDXimiEDabq0"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/apify~monitoring-checker-schema/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-apify-monitoring-checker-schema",
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-checker-schema/runs": {
50 "post": {
51 "operationId": "runs-sync-apify-monitoring-checker-schema",
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-checker-schema/run-sync": {
93 "post": {
94 "operationId": "run-sync-apify-monitoring-checker-schema",
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 "options",
135 "subjectType",
136 "name",
137 "id"
138 ],
139 "properties": {
140 "options": {
141 "title": "Validation options",
142 "type": "string",
143 "description": "List of validation options selected by list of dataset IDs or by the regular expression. It is possible to define minimum item count, maximum item count and validation schema (type-check) for each defined validation options."
144 },
145 "subjectType": {
146 "title": "Subject type",
147 "enum": [
148 "ACTOR",
149 "TASK",
150 "NAMED_DATASET"
151 ],
152 "type": "string",
153 "description": "Type of the resource to checked.",
154 "default": "ACTOR"
155 },
156 "name": {
157 "title": "Subject name",
158 "type": "string",
159 "description": "Name of actor, task or dataset to be checked."
160 },
161 "id": {
162 "title": "Subject id",
163 "type": "string",
164 "description": "Id of actor, task or dataset to be checked."
165 },
166 "runs": {
167 "title": "List of runs",
168 "type": "array",
169 "description": "List of specific actor or task runs.",
170 "default": [],
171 "items": {
172 "type": "string"
173 }
174 }
175 }
176 },
177 "runsResponseSchema": {
178 "type": "object",
179 "properties": {
180 "data": {
181 "type": "object",
182 "properties": {
183 "id": {
184 "type": "string"
185 },
186 "actId": {
187 "type": "string"
188 },
189 "userId": {
190 "type": "string"
191 },
192 "startedAt": {
193 "type": "string",
194 "format": "date-time",
195 "example": "2025-01-08T00:00:00.000Z"
196 },
197 "finishedAt": {
198 "type": "string",
199 "format": "date-time",
200 "example": "2025-01-08T00:00:00.000Z"
201 },
202 "status": {
203 "type": "string",
204 "example": "READY"
205 },
206 "meta": {
207 "type": "object",
208 "properties": {
209 "origin": {
210 "type": "string",
211 "example": "API"
212 },
213 "userAgent": {
214 "type": "string"
215 }
216 }
217 },
218 "stats": {
219 "type": "object",
220 "properties": {
221 "inputBodyLen": {
222 "type": "integer",
223 "example": 2000
224 },
225 "rebootCount": {
226 "type": "integer",
227 "example": 0
228 },
229 "restartCount": {
230 "type": "integer",
231 "example": 0
232 },
233 "resurrectCount": {
234 "type": "integer",
235 "example": 0
236 },
237 "computeUnits": {
238 "type": "integer",
239 "example": 0
240 }
241 }
242 },
243 "options": {
244 "type": "object",
245 "properties": {
246 "build": {
247 "type": "string",
248 "example": "latest"
249 },
250 "timeoutSecs": {
251 "type": "integer",
252 "example": 300
253 },
254 "memoryMbytes": {
255 "type": "integer",
256 "example": 1024
257 },
258 "diskMbytes": {
259 "type": "integer",
260 "example": 2048
261 }
262 }
263 },
264 "buildId": {
265 "type": "string"
266 },
267 "defaultKeyValueStoreId": {
268 "type": "string"
269 },
270 "defaultDatasetId": {
271 "type": "string"
272 },
273 "defaultRequestQueueId": {
274 "type": "string"
275 },
276 "buildNumber": {
277 "type": "string",
278 "example": "1.0.0"
279 },
280 "containerUrl": {
281 "type": "string"
282 },
283 "usage": {
284 "type": "object",
285 "properties": {
286 "ACTOR_COMPUTE_UNITS": {
287 "type": "integer",
288 "example": 0
289 },
290 "DATASET_READS": {
291 "type": "integer",
292 "example": 0
293 },
294 "DATASET_WRITES": {
295 "type": "integer",
296 "example": 0
297 },
298 "KEY_VALUE_STORE_READS": {
299 "type": "integer",
300 "example": 0
301 },
302 "KEY_VALUE_STORE_WRITES": {
303 "type": "integer",
304 "example": 1
305 },
306 "KEY_VALUE_STORE_LISTS": {
307 "type": "integer",
308 "example": 0
309 },
310 "REQUEST_QUEUE_READS": {
311 "type": "integer",
312 "example": 0
313 },
314 "REQUEST_QUEUE_WRITES": {
315 "type": "integer",
316 "example": 0
317 },
318 "DATA_TRANSFER_INTERNAL_GBYTES": {
319 "type": "integer",
320 "example": 0
321 },
322 "DATA_TRANSFER_EXTERNAL_GBYTES": {
323 "type": "integer",
324 "example": 0
325 },
326 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
327 "type": "integer",
328 "example": 0
329 },
330 "PROXY_SERPS": {
331 "type": "integer",
332 "example": 0
333 }
334 }
335 },
336 "usageTotalUsd": {
337 "type": "number",
338 "example": 0.00005
339 },
340 "usageUsd": {
341 "type": "object",
342 "properties": {
343 "ACTOR_COMPUTE_UNITS": {
344 "type": "integer",
345 "example": 0
346 },
347 "DATASET_READS": {
348 "type": "integer",
349 "example": 0
350 },
351 "DATASET_WRITES": {
352 "type": "integer",
353 "example": 0
354 },
355 "KEY_VALUE_STORE_READS": {
356 "type": "integer",
357 "example": 0
358 },
359 "KEY_VALUE_STORE_WRITES": {
360 "type": "number",
361 "example": 0.00005
362 },
363 "KEY_VALUE_STORE_LISTS": {
364 "type": "integer",
365 "example": 0
366 },
367 "REQUEST_QUEUE_READS": {
368 "type": "integer",
369 "example": 0
370 },
371 "REQUEST_QUEUE_WRITES": {
372 "type": "integer",
373 "example": 0
374 },
375 "DATA_TRANSFER_INTERNAL_GBYTES": {
376 "type": "integer",
377 "example": 0
378 },
379 "DATA_TRANSFER_EXTERNAL_GBYTES": {
380 "type": "integer",
381 "example": 0
382 },
383 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
384 "type": "integer",
385 "example": 0
386 },
387 "PROXY_SERPS": {
388 "type": "integer",
389 "example": 0
390 }
391 }
392 }
393 }
394 }
395 }
396 }
397 }
398 }
399}Monitoring Checker Schema 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 Checker Schema 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.
