{ "openapi": "3.0.1", "info": { "title": "Dataset Change Detector: new, removed, changed items", "description": "Compare the previous and current dataset of a scheduled scraper and output only what changed: new items, removed items and changed fields with before/after values and % change. Price, stock, jobs and listings monitoring. $0.50 per 1,000 changes.", "version": "0.1", "x-build-id": "foaWE9M5CdVYjvVbD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~dataset-change-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-dataset-change-detector", "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/ucchiii~dataset-change-detector/runs": { "post": { "operationId": "runs-sync-ucchiii-dataset-change-detector", "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/ucchiii~dataset-change-detector/run-sync": { "post": { "operationId": "run-sync-ucchiii-dataset-change-detector", "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": { "previousDatasetId": { "title": "Previous dataset", "type": "string", "description": "Dataset ID of the earlier scraper run (its 'defaultDatasetId', e.g. 'WkzbQMuFYuamGv3YF'): the baseline. Required for real results; leave both datasets empty for a free demo on sample data." }, "currentDatasetId": { "title": "Current dataset", "type": "string", "description": "Dataset ID of the latest scraper run (its 'defaultDatasetId', e.g. 'Hs8qLk2VnBd9RtXyz'). Items are compared against the previous dataset. Required for real results; leave empty for a free demo." }, "keyFields": { "title": "Key fields", "type": "array", "description": "Fields that identify the same item across runs, e.g. ['url'] or ['asin']. Dot paths allowed. Empty = automatic: url, then id, then a hash of the whole item.", "items": { "type": "string" } }, "watchFields": { "title": "Fields to watch", "type": "array", "description": "Only changes in these fields count (e.g. ['price', 'inStock', 'offer.price']). Empty = all fields.", "items": { "type": "string" } }, "ignoreFields": { "title": "Fields to ignore", "type": "array", "description": "Fields never compared, such as scrapedAt or position. Nested paths allowed. If left empty, common timestamp fields (scrapedAt, crawledAt, fetchedAt, loadedAt, timestamp) are ignored automatically.", "items": { "type": "string" } }, "numericChangeThresholdPct": { "title": "Ignore numeric changes below (%)", "minimum": 0, "type": "number", "description": "A numeric field that moved by less than this percentage is not treated as a change. 0 = report every change.", "default": 0 }, "outputTypes": { "title": "Output types", "type": "array", "description": "Which kinds of results to write: any of 'added' (new items), 'removed' (items gone), 'changed' (items with changed fields), 'unchanged'. Default: added, removed, changed. Every written item is billed as one change, including unchanged items if you select them.", "items": { "type": "string", "enum": [ "added", "removed", "changed", "unchanged" ] }, "default": [ "added", "removed", "changed" ] } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }