{ "openapi": "3.0.1", "info": { "title": "Web Scraping Data Export API - Grepsr Reports, Runs and Files", "description": "Export the data of your own Grepsr web scraping projects: every scraped record of a report's latest run or any history, run history with item counts, output file links, run parameters and schedules, plus your projects. Read only: nothing is run or stopped. Bring your own key.", "version": "0.1", "x-build-id": "xYxaVwUCBwUlXAdd9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~web-scraping-data-export-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-web-scraping-data-export-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-data-export-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-web-scraping-data-export-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-data-export-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-web-scraping-data-export-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": [ "projects", "latestRecords", "historyRecords", "histories", "runs", "searchRuns", "historyFiles", "historyStatus", "reportParameters", "schedules", "scheduleParameters" ], "type": "string", "description": "Projects lists every project in the account and needs nothing else, so it is the default. Latest scraped records reads the newest finished history of each report id and returns every scraped record in its JSON or CSV file. Scraped records of a history does the same for one history id. Histories and runs list the times a report ran, which is where history ids come from. The other services read output file links, run status, run parameters and schedules.", "default": "projects" }, "identifiers": { "title": "Ids", "type": "array", "description": "One per line, as numbers. Report ids for latest scraped records, histories, runs, search runs, report parameters and schedules; history ids for scraped records of a history, files and status; schedule ids (or scheduler job ids) for parameters of a schedule. A report id is the number in the report's address in the web app. Projects reads none.", "items": { "type": "string" } }, "runCount": { "title": "Histories or runs per report", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Histories and runs only: how many the provider returns for each report, sent as its size field. The provider has no paging, so this is the whole list.", "default": 20 }, "searchParams": { "title": "Search parameters", "type": "object", "description": "Search runs only: the run parameters to match, as a JSON object of parameter name to value, such as {\"file_name\": \"2023_12_15_export.xlsx\"}. Parameter names are the ones parameters of a report lists." }, "reportId": { "title": "Report id for schedule parameters", "type": "string", "description": "Parameters of a schedule only: the report the schedule ids belong to." }, "projectType": { "title": "Project type", "enum": [ "WEBAPP", "any" ], "type": "string", "description": "Projects only: WEBAPP, the type the provider documents and the default, or any to send no type.", "default": "WEBAPP" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. One output file can hold tens of thousands of scraped records.", "default": 1000 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 100, "type": "integer", "description": "Pacing ceiling for calls to the provider, which allows 100 per minute per user across all routes. Rate limited answers are retried after a pause.", "default": 60 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key, shown under Personal Details on the Profile page of your Grepsr account. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret. The key is sent only to the API host, never to file links, and is never 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 } } } } } } } } } }