{ "openapi": "3.0.1", "info": { "title": "Agentic Commerce Readiness Index - UCP, ACP & AI-Shopping Audit", "description": "Score any storefront 0-100 on how ready it is for AI shopping agents — Universal Commerce Protocol manifest, ACP product-feed conformance, structured data, AI-crawler policy — and track adoption over time. Cohort mode turns 500 merchants into an adoption curve you cannot buy retroactively.", "version": "1.0", "x-build-id": "rrNcuTeFamSW8wQCi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yasaslive~agentic-commerce-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yasaslive-agentic-commerce-radar", "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/yasaslive~agentic-commerce-radar/runs": { "post": { "operationId": "runs-sync-yasaslive-agentic-commerce-radar", "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/yasaslive~agentic-commerce-radar/run-sync": { "post": { "operationId": "run-sync-yasaslive-agentic-commerce-radar", "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": [ "domains" ], "properties": { "domains": { "title": "Domains to audit", "type": "array", "description": "Storefront domains or URLs. Bare domains ('allbirds.com') and full URLs ('https://allbirds.com/collections/all') both work — everything is normalised to an origin. Pass more than one to unlock cohort mode, which writes COHORT.json with adoption rates across the whole list. The defaults are three real domains verified during the build: two serve a live UCP manifest, one returns 404.", "default": [ "allbirds.com", "barnesandnoble.com", "store.google.com" ], "items": { "type": "string" } }, "productSampleSize": { "title": "Products to validate per domain", "minimum": 0, "maximum": 250, "type": "integer", "description": "How many products to pull from the detected public catalog surface and validate against the ACP feed field requirements. Set to 0 to skip product validation entirely and score only the manifest, structured data and crawler policy.", "default": 25 }, "includeProductDetail": { "title": "Emit per-product feed-gap records", "type": "boolean", "description": "When on, pushes one dataset record per sampled product listing its missing ACP fields and truncation warnings. Useful for handing a merchant an exact fix list; noisy for cohort sweeps. The aggregate conformance percentage is always included in the domain record either way.", "default": false }, "generateReports": { "title": "Generate a REPORT.md per domain", "type": "boolean", "description": "Writes a human-readable Markdown audit per domain to the key-value store (exec summary, score breakdown, top fixes, raw manifest). NOTE: this is the actor's one expensive event at $2.00 per report — a 500-domain sweep with this on bills $1,000+. It ships OFF so the default run stays cheap; turn it on for the handful of merchants you actually want a document for.", "default": false }, "storeName": { "title": "Snapshot store name", "type": "string", "description": "Named key-value store holding the previous scan per domain. Change detection compares against whatever is in here, so keeping the default means every scheduled run of this actor contributes to the same longitudinal dataset. Use a different name to keep a client's cohort history separate.", "default": "agentic-commerce-snapshots" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Every probe is a public, unauthenticated GET, so a proxy is not required. It helps when sweeping many domains on one CDN that rate-limits by IP, or when a merchant geo-restricts. Datacenter proxies are usually sufficient and far cheaper than residential.", "default": { "useApifyProxy": false } }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Optional. Posts a short summary of adoption changes (who switched UCP on, who turned it off, score moves) after each run. Only fires when there is something to report, so a quiet week stays quiet." }, "alertWebhookUrl": { "title": "Generic alert webhook URL", "type": "string", "description": "Optional. POSTs the full JSON change payload to any endpoint you control — for piping adoption deltas into your own warehouse, CRM or alerting stack." }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Optional, and genuinely optional — every score, sub-score and fix in this actor is computed deterministically without it. Supplying a key adds a plain-English remediation narrative to each REPORT.md, nothing more. Costs are billed to your own OpenAI account." } } }, "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 } } } } } } } } } }