# Dataset Drift Monitor (`checksmithcats/dataset-drift-monitor`) Actor Scheduled scraper ran successfully, but did the output quietly change? Compare the current dataset shape with the latest baseline for count, field, missing-rate, and type-distribution drift. - **URL**: https://apify.com/checksmithcats/dataset-drift-monitor.md - **Developed by:** [Checksmith Cats](https://apify.com/checksmithcats) (community) - **Categories:** Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.60 / report generated This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## Dataset Drift Monitor Dataset Drift Monitor compares the current shape of a scraper dataset with the latest compact baseline for the same identity. It is for scraper operators who need to catch quiet output changes such as sudden row-count drops, missing fields, removed fields, or type changes. It can read a dataset ID, resolve an Actor run ID to its default dataset, or analyze submitted JSON/CSV data. API tokens and raw row values are not stored in the report, Evidence Pack, or drift state. ### What It Checks - Record count drop versus the previous compact baseline - Field additions and removals - Field missing-rate increases - Field type-distribution shifts - First-run baseline creation ### Boundaries This is an aggregate output-shape monitor. It does not independently check source pages, prove scraper correctness, repair missing records, judge legality, or promise alert coverage. It records what changed in the sampled dataset output. ### Billing Recommended launch pricing: - `dataset-drift-report-generated`: USD 0.60 per generated drift report - `dataset-row-sampled`: USD 0.01 per sampled row Invalid input and dataset load/compare failures are not charged. ### Local Example ```bash PYTHONPATH=src python -m apify_dataset_drift_monitor.cli examples/sample-input.json --json report.json --md report.md ```` # Actor input Schema ## `datasetId` (type: `string`): Dataset ID to read through the platform API. ## `runId` (type: `string`): Actor run ID. The monitor resolves its default dataset ID. ## `apiToken` (type: `string`): Optional token for private datasets or runs. Sent in the Authorization header only and not stored in reports or state. ## `items` (type: `array`): Optional inline array of item objects. Use this when not reading from Apify API. ## `dataJson` (type: `string`): Optional JSON array, or an object with an items array. ## `csvText` (type: `string`): Optional CSV with a header row. Values are analyzed only as aggregate shape signals. ## `baselineKey` (type: `string`): Stable identity used for repeated comparisons. Required for submitted data and recommended for runId-based checks. ## `sampleLimit` (type: `integer`): Maximum number of rows to sample from the current dataset. Keep the default small for scheduled runs. ## `countDropRatio` (type: `number`): Warn when record count drops by at least this ratio compared with the latest baseline. ## `missingRateDelta` (type: `number`): Warn when a field's missing rate increases by at least this absolute amount. ## `typeShiftDelta` (type: `number`): Warn when a field's observed type distribution moves by at least this amount. ## `stateStoreName` (type: `string`): Key-value store name for the latest compact baseline snapshot. ## Actor input object example ```json { "sampleLimit": 200, "countDropRatio": 0.25, "missingRateDelta": 0.2, "typeShiftDelta": 0.5, "stateStoreName": "dataset-drift-monitor-state" } ``` # Actor output Schema ## `results` (type: `string`): No description ## `report` (type: `string`): No description # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("checksmithcats/dataset-drift-monitor").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 = {} # Run the Actor and wait for it to finish run = client.actor("checksmithcats/dataset-drift-monitor").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 '{}' | apify call checksmithcats/dataset-drift-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=checksmithcats/dataset-drift-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Dataset Drift Monitor", "description": "Scheduled scraper ran successfully, but did the output quietly change? Compare the current dataset shape with the latest baseline for count, field, missing-rate, and type-distribution drift.", "version": "0.1", "x-build-id": "VlPIaK6n8jL0xatNV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/checksmithcats~dataset-drift-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-checksmithcats-dataset-drift-monitor", "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/checksmithcats~dataset-drift-monitor/runs": { "post": { "operationId": "runs-sync-checksmithcats-dataset-drift-monitor", "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/checksmithcats~dataset-drift-monitor/run-sync": { "post": { "operationId": "run-sync-checksmithcats-dataset-drift-monitor", "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", "properties": { "datasetId": { "title": "Dataset ID", "type": "string", "description": "Dataset ID to read through the platform API." }, "runId": { "title": "Actor run ID", "type": "string", "description": "Actor run ID. The monitor resolves its default dataset ID." }, "apiToken": { "title": "API token", "type": "string", "description": "Optional token for private datasets or runs. Sent in the Authorization header only and not stored in reports or state." }, "items": { "title": "Submitted JSON items", "type": "array", "description": "Optional inline array of item objects. Use this when not reading from Apify API.", "items": { "type": "object" } }, "dataJson": { "title": "Submitted JSON text", "type": "string", "description": "Optional JSON array, or an object with an items array." }, "csvText": { "title": "Submitted CSV text", "type": "string", "description": "Optional CSV with a header row. Values are analyzed only as aggregate shape signals." }, "baselineKey": { "title": "Stable baseline key", "type": "string", "description": "Stable identity used for repeated comparisons. Required for submitted data and recommended for runId-based checks." }, "sampleLimit": { "title": "Sample limit", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of rows to sample from the current dataset. Keep the default small for scheduled runs.", "default": 200 }, "countDropRatio": { "title": "Record-count drop threshold", "minimum": 0.01, "maximum": 0.95, "type": "number", "description": "Warn when record count drops by at least this ratio compared with the latest baseline.", "default": 0.25 }, "missingRateDelta": { "title": "Field missing-rate increase threshold", "minimum": 0.01, "maximum": 1, "type": "number", "description": "Warn when a field's missing rate increases by at least this absolute amount.", "default": 0.2 }, "typeShiftDelta": { "title": "Type-distribution shift threshold", "minimum": 0.01, "maximum": 1, "type": "number", "description": "Warn when a field's observed type distribution moves by at least this amount.", "default": 0.5 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Key-value store name for the latest compact baseline snapshot.", "default": "dataset-drift-monitor-state" } } }, "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 } } } } } } } } } } ```