{ "openapi": "3.0.1", "info": { "title": "Dataset Router & Splitter — Route Records", "description": "Split any Apify dataset into separate output datasets using ordered rules. Route nested fields with text, numeric, regex, list, existence, and empty-value conditions—without custom glue code.", "version": "0.2", "x-build-id": "yYtlz5mDzN1jalcwi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/orangepinlabs~dataset-router/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-orangepinlabs-dataset-router", "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-router/runs": { "post": { "operationId": "runs-sync-orangepinlabs-dataset-router", "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-router/run-sync": { "post": { "operationId": "run-sync-orangepinlabs-dataset-router", "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": [ "sourceDatasetId", "rules" ], "properties": { "sourceDatasetId": { "title": "Source dataset", "type": "string", "description": "Dataset ID or name containing the records to route." }, "rules": { "title": "Routing rules", "minItems": 1, "maxItems": 8, "type": "array", "description": "Ordered rules. Each rule has a route name, all/any matching, and one or more field conditions. With First match, the first matching rule wins.", "items": { "type": "object", "properties": { "route": { "title": "Route name", "type": "string", "description": "Human-readable route name. Must be unique.", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$" }, "match": { "title": "Condition matching", "type": "string", "description": "Require all conditions in this rule, or accept any one condition.", "enum": [ "all", "any" ], "default": "all" }, "conditions": { "title": "Conditions", "type": "array", "description": "Field comparisons evaluated for this route.", "minItems": 1, "items": { "type": "object", "properties": { "field": { "title": "Field path", "type": "string", "description": "Dot path such as company.country or product.price." }, "operator": { "title": "Operator", "type": "string", "description": "Comparison to apply to the selected field.", "enum": [ "equals", "notEquals", "contains", "notContains", "startsWith", "endsWith", "regex", "in", "notIn", "gt", "gte", "lt", "lte", "exists", "missing", "isEmpty", "isNotEmpty" ] }, "value": { "title": "Comparison value", "type": "string", "description": "Comparison value. Numbers can be entered as text, such as 500. Omit for exists, missing, isEmpty, and isNotEmpty." }, "values": { "title": "Comparison values", "type": "array", "description": "List of accepted or rejected values for the in and notIn operators.", "editor": "stringList", "items": { "type": "string" } }, "caseSensitive": { "title": "Case sensitive", "type": "boolean", "description": "Use exact letter case for string comparisons and regular expressions.", "default": true } }, "required": [ "field", "operator" ] } } }, "required": [ "route", "conditions" ] }, "default": [ { "route": "high-value-us", "match": "all", "conditions": [ { "field": "country", "operator": "equals", "value": "US" }, { "field": "price", "operator": "gte", "value": "500" } ] } ] }, "routingMode": { "title": "Routing mode", "enum": [ "firstMatch", "allMatches" ], "type": "string", "description": "Send each source record only to its first matching rule, or copy it to every matching rule.", "default": "firstMatch" }, "writeUnmatched": { "title": "Create an unmatched route", "type": "boolean", "description": "Route records that match no rule into the next available route dataset.", "default": true }, "unmatchedRoute": { "title": "Unmatched route name", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,79}$", "type": "string", "description": "Name assigned to records that do not satisfy any explicit rule.", "default": "unmatched" }, "maxItems": { "title": "Maximum source records", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Safety limit. The run fails before routing if the source dataset is larger.", "default": 100000 } } }, "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 } } } } } } } } } }