{ "openapi": "3.0.1", "info": { "title": "Dataset Delta — Added, Removed & Changed Records", "description": "Compare two Apify datasets or track one dataset between runs. Emit only added, removed, and changed records with exact changed fields.", "version": "0.1", "x-build-id": "vpGuLTEzd0XtMOLcx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/orangepinlabs~dataset-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-orangepinlabs-dataset-delta", "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/orangepinlabs~dataset-delta/runs": { "post": { "operationId": "runs-sync-orangepinlabs-dataset-delta", "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/orangepinlabs~dataset-delta/run-sync": { "post": { "operationId": "run-sync-orangepinlabs-dataset-delta", "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": [ "mode", "currentDatasetId", "keyFields" ], "properties": { "mode": { "title": "Mode", "enum": [ "compare", "track" ], "type": "string", "description": "Compare two datasets now, or compare a dataset with this Actor's saved snapshot.", "default": "compare" }, "currentDatasetId": { "title": "Current dataset", "type": "string", "description": "The newer/current dataset ID or name." }, "baselineDatasetId": { "title": "Baseline dataset", "type": "string", "description": "Required in Compare mode. The older dataset ID or name." }, "keyFields": { "title": "Unique key fields", "type": "array", "description": "One or more fields that uniquely identify a record, such as url, id, or company.id.", "items": { "type": "string" }, "default": [ "url" ] }, "ignoreFields": { "title": "Fields to ignore", "type": "array", "description": "Fields that should not trigger a change, such as scrapedAt or metadata.requestId. Dot paths are supported.", "items": { "type": "string" }, "default": [] }, "stateKey": { "title": "Tracking state name", "pattern": "^[A-Za-z0-9._-]{1,80}$", "type": "string", "description": "Track mode only. Use a different value for each scheduled source.", "default": "default" }, "emitInitialSnapshot": { "title": "Emit every record on the first tracking run", "type": "boolean", "description": "Off by default so initializing a tracker does not create a large, chargeable change feed.", "default": false }, "maxItems": { "title": "Maximum records per dataset", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Safety limit applied separately to the current and baseline datasets.", "default": 10000 }, "includeUnchanged": { "title": "Include unchanged records", "type": "boolean", "description": "Normally off. Enable for debugging or complete audit exports.", "default": false } } }, "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 } } } } } } } } } }