{ "openapi": "3.0.1", "info": { "title": "Site Audit: Full-Site SEO Audit with Fixes", "description": "Audit every page of a website for SEO problems in one run. Each page gets a score from 0 to 100, its issues and a one-line fix for each. Run it again and each page is marked new, changed or unchanged, with pages that are gone. $0.005 per page, no browser, no monthly fee.", "version": "0.1", "x-build-id": "DxcvmOFyp7NcWIkoD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bjgomes~site-audit-seo/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bjgomes-site-audit-seo", "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/bjgomes~site-audit-seo/runs": { "post": { "operationId": "runs-sync-bjgomes-site-audit-seo", "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/bjgomes~site-audit-seo/run-sync": { "post": { "operationId": "run-sync-bjgomes-site-audit-seo", "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": "Website", "type": "string", "description": "The website or page to audit, e.g. https://example.com (one per run). By default its pages are found from the site's sitemap (robots.txt, /sitemap.xml, /sitemap_index.xml), plus pages its menus link to that the sitemap leaves out, or, when it has none, by following links on the same site. A sitemap URL works too. To audit only this one URL, set discovery to 'page'." }, "maxPages": { "title": "Maximum pages to audit", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after auditing this many pages. Only pages that answer are counted and charged, so this caps the cost. Use 10 for a quick look. Not used with discovery 'page', which audits one page.", "default": 100 }, "discovery": { "title": "How to find pages", "enum": [ "auto", "page", "sitemap", "crawl" ], "type": "string", "description": "How to find pages. 'auto' (default): the sitemap, plus pages the start page's header, footer and menus link to that the sitemap leaves out (on Shopify, the policy pages); or following links on the same site when there's no sitemap. 'page': only startUrl itself, no sitemap and no crawl; the quickest run, usually a few seconds. 'sitemap': only pages the sitemap lists. 'crawl': only pages reached by following links from startUrl, up to maxDepth.", "default": "auto" }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "When crawling, how many clicks from the start page to follow. 0 audits the start page only.", "default": 5 }, "checkInternalLinks": { "title": "Check internal links", "type": "boolean", "description": "true: request each link to the same site once (up to 100 new links per page) and list the broken ones on every page that has them. false: skip link checks, which is faster.", "default": true }, "compareWithPreviousRun": { "title": "Compare with the previous run", "type": "boolean", "description": "true: mark each page new, changed or unchanged since the last audit of the same startUrl, and list pages that are gone (change 'removed'). The record is kept in your account's key-value store 'site-audit-history'; a 'page' audit keeps its own record. false: no comparison, nothing stored.", "default": true }, "includeMarkdown": { "title": "Include page content as Markdown", "type": "boolean", "description": "true: add the page's main content as Markdown (headings, paragraphs, lists and code; navigation, header, footer and sidebars left out; up to 50,000 characters per page), for example to feed an LLM. No extra charge.", "default": false }, "slowThresholdMs": { "title": "Slow response threshold (ms)", "minimum": 100, "maximum": 120000, "type": "integer", "description": "A page that takes longer than this many milliseconds to answer gets a slow-response warning.", "default": 3000 }, "maxConcurrency": { "title": "Maximum concurrent requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Requests in flight at once. Never more than 4 at a time to one host, and robots.txt Crawl-delay is honoured.", "default": 5 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Seconds to wait for any one page, link, sitemap or robots.txt request before recording it as a timeout.", "default": 20 } } }, "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 } } } } } } } } } }