{ "openapi": "3.0.1", "info": { "title": "Web Scraping Results API - Dexi Robots, Runs and Datasets", "description": "Export the output of your own Dexi web scraping robots: every scraped row of the latest or any execution, execution history and usage statistics, dataset rows with filters, plus your robots and runs. Read only: nothing is started or changed. Bring your own key.", "version": "0.1", "x-build-id": "aqIaglDZMl0AMyN89" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~web-scraping-robot-results-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-web-scraping-robot-results-api", "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/nabeelbaghoor~web-scraping-robot-results-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-web-scraping-robot-results-api", "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/nabeelbaghoor~web-scraping-robot-results-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-web-scraping-robot-results-api", "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": { "service": { "title": "What to read", "enum": [ "robots", "runs", "executions", "latestResult", "executionResult", "executionStats", "datasetRows" ], "type": "string", "description": "Robots lists every robot in the account and needs nothing else, so it is the default. Runs lists each robot's saved configurations, which is where run ids come from. Executions lists the times a run ran, which is where execution ids come from. Latest result and result of an execution return every scraped row. Execution statistics give usage and result counts. Dataset rows reads rows collected into a dataset.", "default": "robots" }, "identifiers": { "title": "Ids", "type": "array", "description": "One per line. Run ids for executions and latest result, execution ids for result of an execution and execution statistics, dataset ids for dataset rows, and optionally robot ids to narrow runs. Robots reads none.", "items": { "type": "string" } }, "resultState": { "title": "Latest result from executions in state", "enum": [ "OK", "any", "FAILED", "STOPPED", "RUNNING", "PENDING", "QUEUED" ], "type": "string", "description": "Latest result only: the state of the execution whose result is read. OK, the default, reads the latest successful execution; any sends no state and reads the latest execution whatever its state.", "default": "OK" }, "fromDate": { "title": "From date", "type": "string", "description": "Executions only: list executions from this date, as YYYY-MM-DD or YYYY-MM-DD HH:mm:ss." }, "toDate": { "title": "To date", "type": "string", "description": "Executions only: list executions up to this date, as YYYY-MM-DD (the whole day) or YYYY-MM-DD HH:mm:ss." }, "datasetQuery": { "title": "Dataset query", "type": "object", "description": "Dataset rows only: the provider's query, a JSON object of field name to query options, such as {\"price\": {\"type\": \"GT\", \"value\": 10}} or {\"category\": {\"type\": \"IN\", \"values\": [\"Shoes\", \"Bags\"]}}. Nested fields use dots. Left empty, every row is read." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. One execution result can hold thousands of scraped rows.", "default": 1000 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Pacing ceiling for calls to the provider. Rate limited answers are retried after a pause.", "default": 60 }, "accountId": { "title": "Account id", "type": "string", "description": "Your account id, shown on the API page of your Dexi account. Leave blank to use the DATA_API_ACCOUNT_ID environment secret, or paste accountId:apiKey into the API key field instead." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key, generated on the API page of your Dexi account (not the access key, which this actor computes from the two). This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret. The key itself is never sent, written to a row or logged." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 } } } } } } } } } }