{ "openapi": "3.0.1", "info": { "title": "Apify Dataset Diff API - Find New, Removed & Changed Rows", "description": "Compare Apify datasets and get a clean change feed showing only new, removed, and modified records. Perfect for scheduled scrapers, price monitors, lead feeds, SEO checks, and automation workflows in Make, Zapier, n8n, AI agents, and custom APIs.", "version": "0.1", "x-build-id": "pOrl2rv4b0cACBuXC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vincesoft~dataset-diff-change/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vincesoft-dataset-diff-change", "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/vincesoft~dataset-diff-change/runs": { "post": { "operationId": "runs-sync-vincesoft-dataset-diff-change", "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/vincesoft~dataset-diff-change/run-sync": { "post": { "operationId": "run-sync-vincesoft-dataset-diff-change", "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": [ "newDatasetId", "keyFields" ], "properties": { "newDatasetId": { "title": "New dataset ID", "type": "string", "description": "Dataset ID or name containing the latest records to compare." }, "previousDatasetId": { "title": "Previous dataset ID", "type": "string", "description": "Optional dataset ID or name containing the previous records. Leave empty to compare against the saved snapshot." }, "keyFields": { "title": "Key fields", "type": "array", "description": "One or more field names that uniquely identify a row. Dot notation is supported, for example product.id.", "default": [ "id" ], "items": { "type": "string" } }, "compareFields": { "title": "Compare fields", "type": "array", "description": "Optional list of fields to compare. Leave empty to compare all fields except key fields and ignored fields.", "default": [], "items": { "type": "string" } }, "ignoreFields": { "title": "Ignore fields", "type": "array", "description": "Fields to ignore during comparison. Dot notation ignores nested paths.", "default": [], "items": { "type": "string" } }, "saveSnapshot": { "title": "Save snapshot", "type": "boolean", "description": "Save the new dataset as the snapshot for the next run.", "default": true }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Key-value store key used for saved snapshots when no previous dataset is provided.", "default": "LAST_SNAPSHOT" }, "freeSampleMode": { "title": "Free sample mode", "type": "boolean", "description": "Cap compared rows to a small sample for quick trials.", "default": true }, "freeSampleRowLimit": { "title": "Free sample row limit", "minimum": 1, "type": "integer", "description": "Maximum rows loaded from each source when free sample mode is enabled.", "default": 100 }, "maxRows": { "title": "Maximum rows", "minimum": 0, "type": "integer", "description": "Optional hard limit for rows loaded from each source. Use 0 for unlimited unless free sample mode is enabled.", "default": 0 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional HTTP or HTTPS URL to receive the diff payload in webhook-ready JSON batches." }, "webhookBatchSize": { "title": "Webhook batch size", "minimum": 1, "type": "integer", "description": "Maximum number of change records per webhook request.", "default": 100 } } }, "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 } } } } } } } } } }