{ "openapi": "3.0.1", "info": { "title": "Website SEO Audit & Regression Monitor", "description": "Audit complete websites for technical SEO issues, then monitor verified regressions and recoveries across scheduled runs. Crawl via HTTP and sitemaps, get stable issue IDs and webhook-ready events, and keep the last good state when a page is blocked or a crawl is incomplete.", "version": "0.1", "x-build-id": "bVZmOTwt78RW3OV7B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~website-seo-audit-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-website-seo-audit-monitor", "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/automa-flow~website-seo-audit-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-website-seo-audit-monitor", "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/automa-flow~website-seo-audit-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-website-seo-audit-monitor", "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": [ "sites" ], "properties": { "sites": { "title": "Websites", "minItems": 1, "maxItems": 50, "type": "array", "description": "One to 50 public HTTP(S) sites. externalId is echoed for CI, client, environment, or watchlist joins and is never sent to the site.", "items": { "type": "object", "required": [ "url" ], "additionalProperties": false, "properties": { "url": { "title": "Public website URL", "type": "string", "description": "Public http:// or https:// URL on port 80 or 443. Credentials, localhost, private/reserved networks and metadata endpoints are rejected.", "editor": "textfield", "maxLength": 2048 }, "externalId": { "title": "Your external ID", "type": "string", "description": "Optional client, deployment, property, or environment identifier echoed into every record.", "editor": "textfield", "maxLength": 200 } } } }, "mode": { "title": "Mode", "enum": [ "snapshot", "monitor" ], "type": "string", "description": "snapshot returns the current audit without state. monitor compares only complete trustworthy audits with the last successful KVS state.", "default": "monitor" }, "outputMode": { "title": "Output mode", "enum": [ "changesOnly", "all" ], "type": "string", "description": "all emits site, page and event rows. changesOnly emits the per-site status, webhook-ready change events, and any incomplete page rows needed to diagnose retained state. Snapshot mode always emits pages.", "default": "changesOnly" }, "maxPagesPerSite": { "title": "Maximum pages per website", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard per-site discovery and audit ceiling. Hitting the limit marks discovery incomplete and retains the previous monitor state.", "default": 1000 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Fetch robots.txt once per site and do not request disallowed page paths. A robots transport/5xx failure is unknown, not allow-all.", "default": true }, "includePatterns": { "title": "Include URL patterns", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional case-sensitive glob patterns matched against full URLs and paths, for example */blog/*. Leave empty to include the discovered scope.", "items": { "type": "string", "minLength": 1, "maxLength": 500 }, "default": [] }, "excludePatterns": { "title": "Exclude URL patterns", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional case-sensitive glob patterns such as */cart* or */preview/*.", "items": { "type": "string", "minLength": 1, "maxLength": 500 }, "default": [] }, "auditProfile": { "title": "Audit profile", "enum": [ "core", "standard" ], "type": "string", "description": "core checks indexability and essential page tags. standard adds lengths, hreflang, structured data, image alt, broken links and site-wide duplicate analysis.", "default": "standard" }, "proxyConfiguration": { "title": "Optional datacenter proxy fallback", "type": "object", "description": "Direct HTTP is always attempted first. An explicitly configured Apify Proxy is tried only after a blocked or transport-failed direct request. Custom proxy URLs are rejected; residential escalation is never automatic.", "default": { "useApifyProxy": 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 } } } } } } } } } }