{ "openapi": "3.0.1", "info": { "title": "Small Business Website Readiness Audit", "description": "Audit any small-business website in seconds — no browser, no API keys, no bloat. Get a structured dataset and owner-readable Markdown report covering contact signals, broken links, service page presence, metadata quality, and HTTPS basics.", "version": "1.0", "x-build-id": "rXZ1YWAsA0LVSVgU7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ori8_automations~small-business-website-readiness-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ori8_automations-small-business-website-readiness-audit", "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/ori8_automations~small-business-website-readiness-audit/runs": { "post": { "operationId": "runs-sync-ori8_automations-small-business-website-readiness-audit", "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/ori8_automations~small-business-website-readiness-audit/run-sync": { "post": { "operationId": "run-sync-ori8_automations-small-business-website-readiness-audit", "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": [ "startUrl", "acknowledgeAuthorizedUse" ], "properties": { "startUrl": { "title": "Website URL", "type": "string", "description": "Public homepage or starting URL for a website you own or are authorized to audit. Use only non-confidential public websites; do not enter private, credentialed, or internal URLs." }, "maxPages": { "title": "Maximum pages to analyze", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum same-host HTML pages to fetch and analyze. Default 10; maximum 50 to keep runtime and cost predictable.", "default": 10 }, "crawlConcurrency": { "title": "Concurrent requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to fetch in parallel. Higher is faster but hits the target site harder. Default 5; maximum 10.", "default": 5 }, "useSitemapForDiscovery": { "title": "Discover pages from sitemap.xml", "type": "boolean", "description": "Seed the crawl from sitemap.xml / sitemap_index.xml so pages that aren't linked from the homepage are still found.", "default": true }, "respectRobotsDisallow": { "title": "Respect robots.txt Disallow rules", "type": "boolean", "description": "Skip URLs disallowed for this user agent by the site's robots.txt. Polite crawling; recommended on.", "default": true }, "includeRobotsAndSitemapChecks": { "title": "Check robots.txt and sitemap", "type": "boolean", "description": "Fetch robots.txt and sitemap hints for the same host when available.", "default": true }, "includeBrokenInternalLinkCheck": { "title": "Check broken internal links", "type": "boolean", "description": "Check discovered same-domain links within the crawl/page cap for obvious broken internal links.", "default": true }, "retryFailedRequests": { "title": "Retry failed requests", "type": "boolean", "description": "Retry a page once with a short backoff on a transient network error before marking it failed.", "default": true }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 5, "maximum": 30, "type": "integer", "description": "Per-request timeout in seconds. Keep modest for automated tests and predictable cost.", "default": 15 }, "userAgentLabel": { "title": "User agent label", "type": "string", "description": "Optional descriptive user agent label for polite public-page fetching. Do not use this actor to bypass source controls, rate limits, or access restrictions.", "default": "Ori8WebsiteReadinessAudit/1.0" }, "includeMarkdownReport": { "title": "Create Markdown report", "type": "boolean", "description": "Create an owner-readable Markdown report in key-value storage in addition to structured dataset rows.", "default": true }, "acknowledgeAuthorizedUse": { "title": "I am authorized to audit this public website", "type": "boolean", "description": "Required. Use this actor only with public, user-owned, or user-authorized non-confidential websites. No credentialed/private sources, contact harvesting, form submission, Google/Maps/review scraping, or vulnerability scanning.", "default": false } } }, "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 } } } } } } } } } }