{ "openapi": "3.0.1", "info": { "title": "Actor Regression Watch — Dataset Schema, Count & Run Checks", "description": "Checks your own Apify datasets and runs for regressions: item count drops, fields added or removed, type changes, empty fields, failed rows and run time; only counts and field names, never row contents; failed and unchanged rows are never charged. Not affiliated with or endorsed by Apify.", "version": "0.1", "x-build-id": "95GsiGWzRG6kSxN2b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mouadapi~actor-regression-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mouadapi-actor-regression-watch", "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/mouadapi~actor-regression-watch/runs": { "post": { "operationId": "runs-sync-mouadapi-actor-regression-watch", "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/mouadapi~actor-regression-watch/run-sync": { "post": { "operationId": "run-sync-mouadapi-actor-regression-watch", "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": { "datasetIds": { "title": "Datasets to check", "maxItems": 100, "type": "array", "description": "Your datasets, oldest first. Without a watch list, each is compared with the ones before it; with one, with that list's last checks. As an integration of your Actor or task, use [\"{{resource.defaultDatasetId}}\"]: the dataset of the run that just finished. The picker gives this run read access to these datasets only. Leave empty to see a built-in example (free)." }, "mode": { "title": "Mode", "enum": [ "watch", "export" ], "type": "string", "description": "Empty: watch when a watch list name is given, otherwise export. \"watch\" compares each dataset with the watch list's last checks and skips datasets it already checked; \"export\" compares the datasets of this run with each other. An explicit mode wins." }, "stateName": { "title": "Watch list name", "type": "string", "description": "Name of your watch list (kept in your own storage between runs). Each Actor or task an integration names keeps its own baseline in it; without an integration, the list itself is the baseline. Giving a name turns on watch mode; watch mode without a name uses the list \"default\"." }, "requiredFields": { "title": "Required fields", "type": "array", "description": "Fields every row must have, filled. A sampled row without one is a regression, with the count. One field name per line.", "default": [], "items": { "type": "string" } }, "maxItemDropPercent": { "title": "Item count drop (%)", "minimum": 1, "maximum": 100, "type": "integer", "description": "An item count this many percent under the baseline (the median of the earlier checks) is a regression. An empty dataset always is.", "default": 30 }, "maxEmptyIncreasePoints": { "title": "Empty field rise (points)", "minimum": 1, "maximum": 100, "type": "integer", "description": "A field empty in this many more percentage points of the sampled rows than in the baseline is a regression.", "default": 20 }, "maxFailedIncreasePoints": { "title": "Failed or no-data rows rise (points)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Failed rows (a status of failed or error, or a filled error field) or no-data rows rising by this many percentage points is a regression.", "default": 10 }, "maxRunTimeIncreasePercent": { "title": "Run time rise (%)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Integration runs only: a run time this many percent over the baseline, and at least 60 seconds more, is a regression.", "default": 100 }, "baselineChecks": { "title": "Checks in the baseline", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many earlier checks of the same Actor, task or list form the baseline.", "default": 5 }, "sampleSize": { "title": "Rows read per dataset", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Rows read from each dataset for the field checks (the first ones). The item count is always the dataset's own total.", "default": 1000 }, "maxItems": { "title": "Max charged checks", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most datasets checked and charged per run. In watch mode the rest come in the next run.", "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 }, "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 } } } } } } } } } }