{ "openapi": "3.0.1", "info": { "title": "Site Health Auditor - Broken Links, Meta, Vitals, Weekly Diffs", "description": "Crawls a site you own and returns one combined health report: broken internal and outbound links, redirect chains, meta/OG problems, Lighthouse Core Web Vitals, and a diff against the previous run.", "version": "0.1", "x-build-id": "plJZ0ERNfMH4TROma" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yasaslive~site-health-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yasaslive-site-health-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/yasaslive~site-health-audit/runs": { "post": { "operationId": "runs-sync-yasaslive-site-health-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/yasaslive~site-health-audit/run-sync": { "post": { "operationId": "run-sync-yasaslive-site-health-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" ], "properties": { "startUrl": { "title": "Start URL", "pattern": "^https?://", "type": "string", "description": "The site to audit. The crawl stays on this origin. If this URL redirects (for example example.com to www.example.com), the crawl follows it and audits the origin it lands on. Use this on sites you own." }, "maxPages": { "title": "Max pages to crawl", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on pages fetched. The crawl stops here even if more pages are reachable.", "default": 300 }, "maxOutboundChecks": { "title": "Max outbound links to check", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Distinct off-site links to verify. Outbound links are checked with HEAD (falling back to GET), one request at a time per domain. Set to 0 to skip outbound checking entirely.", "default": 500 }, "runLighthouse": { "title": "Run Lighthouse", "type": "boolean", "description": "Measure Core Web Vitals on a sample of pages. Turn this off for a much faster, cheaper link-and-metadata-only audit.", "default": true }, "lighthousePages": { "title": "Pages to measure with Lighthouse", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many pages to audit: the homepage plus the most-linked pages, with one representative page per URL template (so /blog/a and /blog/b count as one).", "default": 5 }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Optional. An incoming-webhook URL. The run summary, including what changed since the last run, is posted here when the audit finishes." }, "reportWebhookUrl": { "title": "Report webhook URL", "type": "string", "description": "Optional. Receives a JSON POST with the full summary and diff when the audit finishes." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Route crawl and link-check traffic through Apify Proxy. Useful when your own site or a CDN rate-limits datacenter IPs.", "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 } } } } } } } } } }