{ "openapi": "3.0.1", "info": { "title": "SiteVerdict — Shopify Store Auditor (speed, SEO, apps)", "description": "Audit any public Shopify store: theme and version, apps that load on the storefront (matched by script signature), speed signals, SEO, cookie consent, accessibility, product-page schema and catalog gaps, with a prioritised fix list and HTML report. Public pages only.", "version": "1.1", "x-build-id": "dqGOfKbtzYHDAkLQ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-shopify-storefront-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-shopify-storefront-auditor", "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/siteverdict~siteverdict-shopify-storefront-auditor/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-shopify-storefront-auditor", "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/siteverdict~siteverdict-shopify-storefront-auditor/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-shopify-storefront-auditor", "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": { "stores": { "title": "Shopify stores", "type": "array", "description": "Store domains or URLs (e.g. allbirds.com). Non-Shopify sites are detected and skipped free of charge. Max 500 per run.", "items": { "type": "string" } }, "sampleMode": { "title": "Sample mode (offline demo, free)", "type": "boolean", "description": "Audit a bundled fictional store; no website is contacted and nothing is charged.", "default": false }, "productPages": { "title": "Product pages to audit per store", "minimum": 0, "maximum": 10, "type": "integer", "description": "Sampled from homepage links and the public catalog. Checks Product schema, add-to-cart form, variant picker, breadcrumbs, alt text.", "default": 3 }, "checkProductsJson": { "title": "Analyse public catalog (/products.json)", "type": "boolean", "description": "Only if the store exposes it publicly AND robots.txt allows it. Counts products without images/descriptions, vendors, price range. No admin access is ever used.", "default": true }, "productsJsonPages": { "title": "Catalog pages (250 products each)", "minimum": 1, "maximum": 4, "type": "integer", "description": "1–4 pages.", "default": 2 }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Each store is fetched politely (1 request/second).", "default": 3 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 90, "type": "integer", "description": "Per request.", "default": 30 }, "monitor": { "title": "Monitoring mode", "type": "boolean", "description": "Remember each store (named store 'siteverdict-shopify-monitor') and report new/resolved issues, apps added/removed, theme changes and score changes since the last run.", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Optional label for separate histories (e.g. per client)." }, "onlyChanges": { "title": "Only output stores that changed", "type": "boolean", "description": "With monitoring on, skip unchanged stores in the dataset (still charged, since the audit ran).", "default": false }, "alertWebhookUrl": { "title": "Alert webhook URL", "type": "string", "description": "Slack incoming webhook or HTTPS JSON endpoint. Monitoring on: alert when a store got worse. Off: alert on high-priority issues." }, "alertFormat": { "title": "Alert format", "enum": [ "slack", "json" ], "type": "string", "description": "Slack or JSON.", "default": "slack" }, "aiProvider": { "title": "AI fix plan (optional, uses YOUR key)", "enum": [ "none", "anthropic", "openai" ], "type": "string", "description": "Turn findings into concrete Shopify admin / Liquid steps with your own Anthropic or OpenAI key. Off by default. Only the findings list is sent.", "default": "none" }, "aiApiKey": { "title": "AI API key", "type": "string", "description": "Your Anthropic or OpenAI key. Stored encrypted, sent only to the provider, never logged or output." }, "aiModel": { "title": "AI model (optional)", "type": "string", "description": "Defaults to a mid-priced model: claude-sonnet-5-5 (Anthropic) or gpt-4.1-mini (OpenAI). You pay the provider directly." } } }, "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 } } } } } } } } } }