{ "openapi": "3.0.1", "info": { "title": "Broken Link & Image Checker - Sitemap or Crawl, $0.0009/URL", "description": "Find broken links and images on your site: crawl pages or read a sitemap.xml, check every link, image and srcset once, and get the status, redirects and the pages each one is on. $0.0009 per URL checked; crawled pages and robots-skipped URLs free. Respects robots.txt.", "version": "1.0", "x-build-id": "hu4ERboYl6zTYfEyj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digivibetech~broken-link-image-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digivibetech-broken-link-image-checker", "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/digivibetech~broken-link-image-checker/runs": { "post": { "operationId": "runs-sync-digivibetech-broken-link-image-checker", "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/digivibetech~broken-link-image-checker/run-sync": { "post": { "operationId": "run-sync-digivibetech-broken-link-image-checker", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Pages or sitemap.xml", "type": "array", "description": "Pages to start from, or sitemap.xml / sitemap index URLs (every page in the sitemap is scanned). Public pages only; robots.txt is respected.", "items": { "type": "string" } }, "maxPages": { "title": "Max pages to scan per start URL", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many HTML pages are scanned for links and images per start URL (free). 1 = only the start page. Pages are fetched at about 1 per second per site, so 20 pages take roughly 20-30 seconds.", "default": 20 }, "followLinks": { "title": "Crawl internal links", "type": "boolean", "description": "Follow links on the same host to find more pages (up to 'Max pages'). Ignored for sitemap input.", "default": true }, "checkLinks": { "title": "Check links", "type": "boolean", "description": "Check targets.", "default": true }, "checkImages": { "title": "Check images", "type": "boolean", "description": "Check , srcset, sources and og:image. Also flags image URLs that do not return an image.", "default": true }, "checkExternal": { "title": "Check external URLs", "type": "boolean", "description": "Also check links and images on other hosts (e.g. your image CDN). Off = same host only.", "default": true }, "maxUrlsToCheck": { "title": "Max URLs to check", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit of unique URLs checked (and charged) per run. URLs on one host are checked at about 1 per second, so 1,000 URLs on your own site take about 17 minutes; external hosts are checked in parallel. If the run's timeout comes first, the run stops early, keeps every result so far and reports how many URLs were left.", "default": 1000 } } }, "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 } } } } } } } } } }