{ "openapi": "3.0.1", "info": { "title": "DCheck Crawl Coverage", "description": "Find missing URLs, duplicate IDs and short text in supplied crawl results. Compare up to 1,000 records against your expected list and return pass, fail or unknown with JSON and HTML reports. No crawling or AI model calls.", "version": "0.0", "x-build-id": "PGy07WvxwAVWNy2bE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dcheck-studio~dcheck-crawl-coverage/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dcheck-studio-dcheck-crawl-coverage", "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/dcheck-studio~dcheck-crawl-coverage/runs": { "post": { "operationId": "runs-sync-dcheck-studio-dcheck-crawl-coverage", "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/dcheck-studio~dcheck-crawl-coverage/run-sync": { "post": { "operationId": "run-sync-dcheck-studio-dcheck-crawl-coverage", "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": [ "expectedIds", "records", "manifestComplete", "captureComplete" ], "properties": { "expectedIds": { "title": "Expected IDs or exact URLs", "type": "array", "description": "Up to 1000 unique strings. No automatic URL normalization." }, "records": { "title": "Extracted records", "type": "array", "description": "Up to 1000 records; complete JSON input at most 5 MiB. Do not include credentials." }, "idField": { "title": "ID field", "type": "string", "description": "Top-level field containing the exact ID or URL in each record.", "default": "url" }, "contentField": { "title": "Content field", "type": "string", "description": "Top-level field containing extracted text; use markdown if appropriate.", "default": "text" }, "minChars": { "title": "Minimum trimmed characters", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Minimum trimmed Unicode code points; does not establish content quality.", "default": 100 }, "manifestComplete": { "title": "Manifest covers the intended scope", "type": "boolean", "description": "Confirm the manifest includes every ID intended for this audit.", "default": false }, "captureComplete": { "title": "All pages of the supplied dataset are included", "type": "boolean", "description": "Confirm records includes the entire export, not one page or a partial run.", "default": false }, "allowEmpty": { "title": "Explicitly allow an empty effective manifest", "type": "boolean", "description": "Opt in to checking an empty manifest; false rejects an empty effective scope.", "default": false }, "excludedIds": { "title": "Explicit exclusions from the manifest", "type": "array", "description": "Unique manifest IDs deliberately removed from the scope. Never inferred.", "default": [] }, "aliases": { "title": "Explicit ID aliases (from/to)", "type": "array", "description": "Mappings from a new ID to an included manifest ID; no chains or guessed redirects.", "default": [] } } }, "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 } } } } } } } } } }