{ "openapi": "3.0.1", "info": { "title": "Listing Quality Checker: Product Page Audit & Score", "description": "Audit any product page or Amazon listing: a 0–100 score and pass, warn or fail checks with a fix for each. Structured data (Product, Offer, GTIN), titles, images and alt text, attributes, shipping and returns, meta tags, canonical, page weight. Compare against competitors; watch for changes.", "version": "0.1", "x-build-id": "GjCh8tkS12djk6N8e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleanpull~listing-quality-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleanpull-listing-quality-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/cleanpull~listing-quality-checker/runs": { "post": { "operationId": "runs-sync-cleanpull-listing-quality-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/cleanpull~listing-quality-checker/run-sync": { "post": { "operationId": "run-sync-cleanpull-listing-quality-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", "properties": { "productUrls": { "title": "Your product pages", "type": "array", "description": "Product page URLs, one per line: from any shop (Shopify, WooCommerce, Magento, BigCommerce, Wix, Squarespace, custom) or an Amazon listing (amazon.com/dp/ASIN, any marketplace). Each page is read once and gets one audit row.", "items": { "type": "string", "pattern": "\\.[A-Za-z]{2,}" } }, "competitorUrls": { "title": "Competitor pages", "type": "array", "description": "Optional. Competitors' product pages for the same product type, one per line. Each is audited too, and every page of yours gets a comparison row: the score gap and the checks where a competitor does better, with your fix.", "items": { "type": "string", "pattern": "\\.[A-Za-z]{2,}" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional. Search terms the listing should carry, one per line (\"chef knife\", \"japanese steel\"). The title checks report which are present and which are missing. Without keywords they check for repeated words and a product type.", "items": { "type": "string" } }, "changesOnly": { "title": "Changes only", "type": "boolean", "description": "Return a page's audit only when it changed since the last run with the same watchlist name: a check that moved (pass, warn or fail), or a score that moved by at least Score change. A page gone (404 or redirected away) is reported as removed only after two runs in a row. The first run is the baseline. Schedule it weekly to catch theme or feed changes that break your listings.", "default": false }, "monitorName": { "title": "Watchlist name", "type": "string", "description": "Runs with the same name compare against each other. Use one name per watchlist.", "default": "default" }, "minScoreChange": { "title": "Score change to report", "minimum": 0, "maximum": 100, "type": "integer", "description": "With Changes only: a score that moved by fewer points, with no check changing, is not reported.", "default": 5 }, "maxRunCostUsd": { "title": "Max cost per run (USD)", "minimum": 0.01, "maximum": 1000, "type": "number", "description": "Optional. Stop once this run's charges would pass this amount. Use it for scheduled runs, which may have no spending limit of their own. Pages not audited are audited on the next run." }, "fields": { "title": "Only these fields", "type": "array", "description": "Optional. Keep only these fields, for example [\"url\", \"score\", \"grade\", \"topFixes\"].", "items": { "type": "string" } }, "maxConcurrency": { "title": "Pages at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages read in parallel. One site gets at most two requests at a time.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The actor picks proxies itself per site: direct, then datacenter, then residential only for sites that block the others." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Accepted for compatibility with other actors: product pages, same as Your product pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } } } }, "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 } } } } } } } } } }