# Monitoring Runner (`apify/monitoring-runner`) Actor The monitoring runner is a part of the Apify Monitoring Suite (apify/monitoring). See its readme for more information and how to use this. - **URL**: https://apify.com/apify/monitoring-runner.md - **Developed by:** [Apify](https://apify.com/apify) (Apify) - **Categories:** Developer tools - **Stats:** 141 total users, 27 monthly users, 99.5% runs succeeded, 16 bookmarks - **User rating**: 4.50 out of 5 stars ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Monitoring runner This actor is a part of Apify Monitoring Suite [apify/monitoring](https://apify.com/apify/monitoring). Its main responsibility is running checkers and reporters. # Actor input Schema ## `projectName` (type: `string`): Name of your monitoring suite. It will be used in notifications and to identify related resources in the Apify dashboard. ## `targetType` (type: `string`): Only one type of target can be monitored by a single monitoring suite. If you want to watch more types, create more monitoring suites. ## `targetPatternList` (type: `array`): 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. ## `targetList` (type: `array`): 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. ## `limit` (type: `integer`): Last items to be checked. If 100 is passed, only last hundred runs/datasets will be checked. ## `saveHistory` (type: `boolean`): All monitoring runs results are saved in named dataset ## `resourceStatsCollector` (type: `boolean`): Works with Subject type 'Actor', 'Task' and 'Named dateaset', Gets information about the runs TODO: LINK TO PA ## `duplicationChecker` (type: `boolean`): Checks for duplicates based on defined unique fields. Based on 'https://apify.com/lukaskrivka/duplications-checker' ## `schemaValidatorChecker` (type: `boolean`): Validates dataset items based on the Type check library ## `runStatusChecker` (type: `boolean`): Validates run status ## `checkers` (type: `array`): Ids of checker actors or tasks that needs ## `checkersInput` (type: `object`): Pass input to checkers ## `dashboard` (type: `boolean`): Works with Subject type 'Actor', 'Task' 'Named dataset'. Starts dashboard actor. LINK TO PA ## `emailReporter` (type: `boolean`): Sends report to mail inbox. LINK TO PA for input ## `slackReporter` (type: `boolean`): Sends report to custom slack channel. LINK TO PA for input ## `reporters` (type: `array`): Id of reporter actors or tasks ## `reportersInput` (type: `object`): Pass input to checkers ## `frequency` (type: `string`): 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. ## Actor input object example ```json { "targetType": "ACTOR", "targetPatternList": [], "targetList": [], "limit": 1000, "saveHistory": false, "checkers": [], "checkersInput": { "RESOURCE_STATS_CHECKER": {}, "DEDUPLICATION_CHECKER": { "uniqueKey": "email" }, "SCHEMA_VALIDATOR_CHECKER": { "options": [ { "resourceList": [ "id", "id" ], "resourceRegex": "", "minItemCount": 100, "maxItemCount": 5000, "validationSchema": "{ address: String, open: Boolean }" } ] } }, "reporters": [], "reportersInput": { "EMAIL_REPORTER": { "sendMailInput": { "to": "info@apify.com", "subject": "My monitoring task report" } }, "SLACK_REPORTER": { "slackInput": { "token": "Your token", "message": "Hey, look what I have done!", "channel": "#monitoring" } }, "DASHBOARD_REPORTER": { "notifyOnUpdate": true } } } ```` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "limit": 1000, "checkersInput": { "RESOURCE_STATS_CHECKER": {}, "DEDUPLICATION_CHECKER": { "uniqueKey": "email" }, "SCHEMA_VALIDATOR_CHECKER": { "options": [ { "resourceList": [ "id", "id" ], "resourceRegex": "", "minItemCount": 100, "maxItemCount": 5000, "validationSchema": "{ address: String, open: Boolean }" } ] } }, "reportersInput": { "EMAIL_REPORTER": { "sendMailInput": { "to": "info@apify.com", "subject": "My monitoring task report" } }, "SLACK_REPORTER": { "slackInput": { "token": "Your token", "message": "Hey, look what I have done!", "channel": "#monitoring" } }, "DASHBOARD_REPORTER": { "notifyOnUpdate": true } } }; // Run the Actor and wait for it to finish const run = await client.actor("apify/monitoring-runner").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "limit": 1000, "checkersInput": { "RESOURCE_STATS_CHECKER": {}, "DEDUPLICATION_CHECKER": { "uniqueKey": "email" }, "SCHEMA_VALIDATOR_CHECKER": { "options": [{ "resourceList": [ "id", "id", ], "resourceRegex": "", "minItemCount": 100, "maxItemCount": 5000, "validationSchema": "{ address: String, open: Boolean }", }] }, }, "reportersInput": { "EMAIL_REPORTER": { "sendMailInput": { "to": "info@apify.com", "subject": "My monitoring task report", } }, "SLACK_REPORTER": { "slackInput": { "token": "Your token", "message": "Hey, look what I have done!", "channel": "#monitoring", } }, "DASHBOARD_REPORTER": { "notifyOnUpdate": True }, }, } # Run the Actor and wait for it to finish run = client.actor("apify/monitoring-runner").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "limit": 1000, "checkersInput": { "RESOURCE_STATS_CHECKER": {}, "DEDUPLICATION_CHECKER": { "uniqueKey": "email" }, "SCHEMA_VALIDATOR_CHECKER": { "options": [ { "resourceList": [ "id", "id" ], "resourceRegex": "", "minItemCount": 100, "maxItemCount": 5000, "validationSchema": "{ address: String, open: Boolean }" } ] } }, "reportersInput": { "EMAIL_REPORTER": { "sendMailInput": { "to": "info@apify.com", "subject": "My monitoring task report" } }, "SLACK_REPORTER": { "slackInput": { "token": "Your token", "message": "Hey, look what I have done!", "channel": "#monitoring" } }, "DASHBOARD_REPORTER": { "notifyOnUpdate": true } } }' | apify call apify/monitoring-runner --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=apify/monitoring-runner", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Monitoring Runner", "description": "The monitoring runner is a part of the Apify Monitoring Suite (apify/monitoring). See its readme for more information and how to use this.", "version": "0.0", "x-build-id": "NsoMmOtydmedVKZXR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apify~monitoring-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apify-monitoring-runner", "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/apify~monitoring-runner/runs": { "post": { "operationId": "runs-sync-apify-monitoring-runner", "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/apify~monitoring-runner/run-sync": { "post": { "operationId": "run-sync-apify-monitoring-runner", "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": [ "targetType" ], "properties": { "projectName": { "title": "Monitoring suite name", "pattern": "^([a-zA-Z0-9!\\-_.'()]{1,15})$", "maxLength": 15, "type": "string", "description": "Name of your monitoring suite. It will be used in notifications and to identify related resources in the Apify dashboard." }, "targetType": { "title": "Type of target", "enum": [ "ACTOR", "TASK", "NAMED_DATASET" ], "type": "string", "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.", "default": "ACTOR" }, "targetPatternList": { "title": "Target name patterns", "type": "array", "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.", "default": [], "items": { "type": "string" } }, "targetList": { "title": "Target IDs", "type": "array", "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.", "default": [], "items": { "type": "string" } }, "limit": { "title": "Max items to be checked", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Last items to be checked. If 100 is passed, only last hundred runs/datasets will be checked. ", "default": 1000 }, "saveHistory": { "title": "Save history", "type": "boolean", "description": "All monitoring runs results are saved in named dataset", "default": false }, "resourceStatsCollector": { "title": "Resource stats collector", "type": "boolean", "description": "Works with Subject type 'Actor', 'Task' and 'Named dateaset', Gets information about the runs TODO: LINK TO PA" }, "duplicationChecker": { "title": "Duplication checker", "type": "boolean", "description": "Checks for duplicates based on defined unique fields. Based on 'https://apify.com/lukaskrivka/duplications-checker'" }, "schemaValidatorChecker": { "title": "Schema validator checker", "type": "boolean", "description": "Validates dataset items based on the Type check library" }, "runStatusChecker": { "title": "Run status validator", "type": "boolean", "description": "Validates run status" }, "checkers": { "title": "Checkers", "uniqueItems": true, "type": "array", "description": "Ids of checker actors or tasks that needs", "default": [], "items": { "type": "string" } }, "checkersInput": { "title": "Checkers input", "type": "object", "description": "Pass input to checkers" }, "dashboard": { "title": "Dashboard", "type": "boolean", "description": "Works with Subject type 'Actor', 'Task' 'Named dataset'. Starts dashboard actor. LINK TO PA" }, "emailReporter": { "title": "Email", "type": "boolean", "description": "Sends report to mail inbox. LINK TO PA for input" }, "slackReporter": { "title": "Slack", "type": "boolean", "description": "Sends report to custom slack channel. LINK TO PA for input" }, "reporters": { "title": "Reporters", "uniqueItems": true, "type": "array", "description": "Id of reporter actors or tasks", "default": [], "items": { "type": "string" } }, "reportersInput": { "title": "Checkers input", "type": "object", "description": "Pass input to checkers" }, "frequency": { "title": "The frequency of task", "type": "string", "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." } } }, "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 } } }, "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 } } } } } } } } } } ```